Description
This service, is to set orders that will be used in optimization.
Input
- apiKey: In order to obtain your API KEY, first log into logvrp web application and click "Manage API Key" button.
- computationTicketID: You will get this using Ticket service.
- completeOrderSet: Orders that will be used in the optimization.
- OrderSet: Order Set information. Just for information, values are not important.
- ID: Station Set ID. You can use 0.
- SetName: Station Set Name.
- RelatedStationSetID: The Station Set ID that this Order Set was being created on. You can use 0.
- OrganizationID: You can use 0.
- CreatorUserID: You can use 0.
- CreatorUserName: You can use "", empty string.
- CreationTime: You can use "", empty string.
- LastUpdatedUserID: You can use 0.
- LastUpdatedTime: You can use "", empty string.
- DataCount: Specify total number of orders that will be passed.
- IsDeleted: You can use false.
- Orders: This parameter is an array of orders. An order contains the following:
- ID: Order ID. An integer. Must be unique in the given array!
- UID: User Order ID. You can use "", empty string.
- FI: From Station ID. An integer. It must be one of the station IDs given in the Stations service
- TI: To Station ID. An integer. It must be one of the station IDs given in the Stations service
- LT: Load Type. An iteger. Known values are: 1-Parcel, 2-Passenger, 3-Liquid, 4-Gravel, 5-Frozen, 6-Flammable, 7-Grabage, 8- Garbage, 9-Fragile, -1-CustomType
- A: Order Amount. A floating point positive number.
- V: Volume. A floating point number.
- W: Weight. A floating point number.
- LD: Loading duration. Duration as an ISO string, in the format: "PxDTyHzM" where x days, y hours, z minutes. Check: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#duration
- UD: Unloading duration. Duration as an ISO string, in the format: "PxDTyHzM" where x days, y hours, z minutes. Check: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#duration
- T1: Minimum pick-up date and time. Pickup time window begins with this value. A string in the format, "\/Date( t ) \/", where t is the Unix epoch.
- T2: Maximum pick-up date and time. Pickup time window ends with this value. A string in the format, "\/Date( t ) \/", where t is the Unix epoch.
- T3: Minimum delivery date and time. Delivery time window begins with this value. A string in the format, "\/Date( t ) \/", where t is the Unix epoch.
- T4: Maximum delivery date and time. Delivery time window ends with this value. A string in the format, "\/Date( t ) \/", where t is the Unix epoch.
- D: Is deleted. You can use false.
- Priority: (NEW) Integer. The priority of orders. Higher value means higher priority. It should be >= 0.
- OrderSet: Order Set information. Just for information, values are not important.
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" , "completeOrderSet" : { "OrderSet" : { "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 }, "Orders" : [ { "ID" : "-1" , "UID" : "ORD-185" , "FI" : "-1" , "TI" : "-2" , "LT" : 1, "A" : 2, "V" : 0, "W" : 0, "LD" : "P0DT0H1M" , "UD" : "P0DT0H2M" , "T1" : null , "T2" : null , "T3" : "\/Date(1282984200000)\/" , "T4" : "\/Date(1282985100000)\/" , "D" : false,
}, { "ID" : "-2" , "UID" : "ORD-186" , "FI" : "-1" , "TI" : "-3" , "LT" : 1, "A" : 3, "V" : 0, "W" : 0, "LD" : "P0DT0H1M" , "UD" : "P0DT0H2M" , "T1" : null , "T2" : null , "T3" : "\/Date(1282986000000)\/" , "T4" : "\/Date(1282986900000)\/" , "D" : false,
}, { "ID" : "-3" , "UID" : "ORD-187" , "FI" : "-1" , "TI" : "-4" , "LT" : 1, "A" : 1, "V" : 0, "W" : 0, "LD" : "P0DT0H1M" , "UD" : "P0DT0H2M" , "T1" : null , "T2" : null , "T3" : "\/Date(1282985100000)\/" , "T4" : "\/Date(1282986000000)\/" , "D" : false,
}, { "ID" : "-4" , "UID" : "ORD-188" , "FI" : "-1" , "TI" : "-5" , "LT" : 1, "A" : 4, "V" : 0, "W" : 0, "LD" : "P0DT0H1M" , "UD" : "P0DT0H2M" , "T1" : null , "T2" : null , "T3" : "\/Date(1282984200000)\/" , "T4" : "\/Date(1282985100000)\/" , "D" : false,
} ] } } |
Headers
Content-Type: application/json |
Method:
POST
Output
Response
{ "Data" : null , "Message" : null , "ReturnCode" : 0, "Success" : true , "success" : true } |
0 Comments