Vehicles - v1

Description

This service, is to set vehicles that will be used in optimization.

Input

  1. apiKey: In order to obtain your API KEY, first log into logvrp web application and click "Manage API Key" button.
  2. computationTicketID: You will get this using Ticket service.
  3. completeVehicleSet: Vehicles that will be used in the optimization.
    1. VehicleSet: Vehicle Set information. Just for information, values are not important.
      1. ID: Vehicle Set ID. You can use 0.
      2. SetName: Vehicle Set Name
      3. RelatedStationSetID: The Station Set ID that this Vehicle Set was being created on. You can use 0.
      4. OrganizationID: You can use 0.
      5. CreatorUserID: You can use 0.
      6. CreatorUserName: You can use "", empty string.
      7. CreationTime: You can use "", empty string.
      8. LastUpdatedUserID: You can use 0.
      9. LastUpdatedTime: You can use "", empty string.
      10. DataCount: Specify total number of orders that will be passed.
      11. IsDeleted: You can use false.
    2. Vehicles: This parameter is an array of vehicles. A vehicle contains the following:
      1. ID: Vehicle ID. An integer. Must be unique in the given array!
      2. N: Vehicle Name. You can use "", empty string.
      3. VID: Vehicle ID. You can use 0.
      4. OID: You can use 0.
      5. CID: You can use 0.
      6. BID: Starting station ID. If undefined, set 0. If defined, then it must be one of the station IDs given in "Stations" service.
      7. EID: Stopping station ID. If undefined, set 0. If defined, then it must be one of the station IDs given in "Stations" service.
      8. LT: Load Type. An integer. Known types: 1-Parcel, 2-Passenger, 3-Liquid, 4-Gravel, 5-Frozen, 6-Flammable, 7-Grabage, 8- Garbage, 9-Fragile, -1 -CustomType
      9. CP: Capacity Amount. A floating point positive number.
      10. CW: Capacity Weight. A floating point number.
      11. CV: Capacity Volume. A floating point number.
      12. S: Average Speed. A floating point non-negative number.
      13. DC: Per Distance Cost. A floating point non-negative number.
      14. F: Fix Cost. A floating point non-negative number.
      15. DD: Departure Date of the vehicle. Earliest date-time that vehicle can start operation. A string in the format, "\/Date( t ) \/", where t is the Unix epoch.
      16. A: Is Active. You can use true.
      17. D: Is Deleted. You can use false.
      18. Priority: (NEW) Integer. Priority of the vehicle over other vehicles. Higher value means higher priority. It should be >= 0.

Output

Data: Result data
Message: Output message
ReturnCode: Return code of the output. If "Success" is true, then check this value.
Success: If unpected errors, or exceptions occur, this will be false.
success: Same as Success

 

REST - JSON

 URL
Input
Body
{
  "apiKey": "your API key here",
  "computationTicketID": "your computation ticket ID here",
  "completeVehicleSet": {
    "VehicleSet": {
      "ID": 0,
      "SetName": "",
      "RelatedStationSetID": 0,
      "OrganizationID": 0,
      "CreatorUserID": 0,
      "CreatorUserName": "",
      "CreationTime": "2012-09-15 00:00:00",
      "LastUpdatedUserID": 0,
      "LastUpdatedTime": "2012-09-15 00:00:00",
      "DataCount": 0,
      "IsDeleted": false
    },
    "Vehicles": [
      {
        "ID": "-1",
        "N": "Vehicle - 1",
        "VID": 0,
        "OID": 0,
        "CID": 0,
        "BID": "-1",
        "EID": "-1",
        "LT": 1,
        "CP": 5,
        "CW": 0,
        "CV": 0,
        "S": 20,
        "DC": 0.5,
        "F": 5,
        "DD": "\/Date(1282970760000)\/",
        "A": true,
        "D": false,
        "Priority": 0
      },{
        "ID": "-2",
        "N": "Vehicle - 2",
        "VID": 0,
        "OID": 0,
        "CID": 0,
        "BID": "-1",
        "EID": "-1",
        "LT": 1,
        "CP": 5,
        "CW": 0,
        "CV": 0,
        "S": 20,
        "DC": 0.5,
        "F": 5,
        "DD": "\/Date(1282970760000)\/",
        "A": true,
        "D": false,
        "Priority": 0
      }
    ]
  }
}
Headers
Content-Type: application/json

 

Method:
 
POST 
 
 
Output
Response
{
  "Data": null,
  "Message": null,
  "ReturnCode": 0,
  "Success": true,
  "success": true
}
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk