POST RouteOptimization/GetRouteOptimization
Returns a list of destinations in an optimized order.
Request Information
URI Parameters
Body Parameters
ClsRouteOptimization| Name | Description | Type | Additional Information |
|---|---|---|---|
| RouteOptimizationGUID |
Route optimization identifier |
globally unique identifier | |
| Vehicles |
List of vehicles to create routes for |
Collection of ClsRouteOptimizationVehicle |
Required List cannot be empty |
| Deliveries |
List of delivery destinations to route |
Collection of ClsRouteOptimizationDelivery |
Required |
| FillSpots |
List of fill spots |
Collection of ClsRouteOptimizationFillSpot |
Required |
| Version |
Version |
integer |
Request Formats
application/json, text/json
Sample:
{
"RouteOptimizationGUID": "9a803ba8-87f8-4c8a-84a8-df62c1d8753a",
"Vehicles": [
{
"VehicleGUID": "71d8f712-5349-4b38-a439-065b6452c47c",
"Capacity": 2.1,
"StartingLatitude": 3.1,
"StartingLongitude": 4.1,
"EndingLatitude": 5.1,
"EndingLongitude": 6.1
},
{
"VehicleGUID": "71d8f712-5349-4b38-a439-065b6452c47c",
"Capacity": 2.1,
"StartingLatitude": 3.1,
"StartingLongitude": 4.1,
"EndingLatitude": 5.1,
"EndingLongitude": 6.1
}
],
"Deliveries": [
{
"DeliveryGUID": "97ec44b0-26d7-45fc-a6d1-4eac04510b7e",
"Latitude": 2.1,
"Longitude": 3.1,
"Quantity": 4.1,
"PreferredVehicle": "9143ae1f-89e6-40e3-85c0-0debe51055ea",
"IsFirstStop": true,
"Priority": 7
},
{
"DeliveryGUID": "97ec44b0-26d7-45fc-a6d1-4eac04510b7e",
"Latitude": 2.1,
"Longitude": 3.1,
"Quantity": 4.1,
"PreferredVehicle": "9143ae1f-89e6-40e3-85c0-0debe51055ea",
"IsFirstStop": true,
"Priority": 7
}
],
"FillSpots": [
{
"FillSpotGUID": "00c70964-98d1-4e42-aad6-378b5f5d912e",
"Latitude": 2.1,
"Longitude": 3.1
},
{
"FillSpotGUID": "00c70964-98d1-4e42-aad6-378b5f5d912e",
"Latitude": 2.1,
"Longitude": 3.1
}
],
"Version": 3
}
application/xml, text/xml
Sample:
<ClsRouteOptimization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Interfaces.RouteOptimization">
<Deliveries>
<ClsRouteOptimization.ClsRouteOptimizationDelivery>
<DeliveryGUID>97ec44b0-26d7-45fc-a6d1-4eac04510b7e</DeliveryGUID>
<IsFirstStop>true</IsFirstStop>
<Latitude>2.1</Latitude>
<Longitude>3.1</Longitude>
<PreferredVehicle>9143ae1f-89e6-40e3-85c0-0debe51055ea</PreferredVehicle>
<Priority>7</Priority>
<Quantity>4.1</Quantity>
</ClsRouteOptimization.ClsRouteOptimizationDelivery>
<ClsRouteOptimization.ClsRouteOptimizationDelivery>
<DeliveryGUID>97ec44b0-26d7-45fc-a6d1-4eac04510b7e</DeliveryGUID>
<IsFirstStop>true</IsFirstStop>
<Latitude>2.1</Latitude>
<Longitude>3.1</Longitude>
<PreferredVehicle>9143ae1f-89e6-40e3-85c0-0debe51055ea</PreferredVehicle>
<Priority>7</Priority>
<Quantity>4.1</Quantity>
</ClsRouteOptimization.ClsRouteOptimizationDelivery>
</Deliveries>
<FillSpots>
<ClsRouteOptimization.ClsRouteOptimizationFillSpot>
<FillSpotGUID>00c70964-98d1-4e42-aad6-378b5f5d912e</FillSpotGUID>
<Latitude>2.1</Latitude>
<Longitude>3.1</Longitude>
</ClsRouteOptimization.ClsRouteOptimizationFillSpot>
<ClsRouteOptimization.ClsRouteOptimizationFillSpot>
<FillSpotGUID>00c70964-98d1-4e42-aad6-378b5f5d912e</FillSpotGUID>
<Latitude>2.1</Latitude>
<Longitude>3.1</Longitude>
</ClsRouteOptimization.ClsRouteOptimizationFillSpot>
</FillSpots>
<RouteOptimizationGUID>9a803ba8-87f8-4c8a-84a8-df62c1d8753a</RouteOptimizationGUID>
<Vehicles>
<ClsRouteOptimization.ClsRouteOptimizationVehicle>
<Capacity>2.1</Capacity>
<EndingLatitude>5.1</EndingLatitude>
<EndingLongitude>6.1</EndingLongitude>
<StartingLatitude>3.1</StartingLatitude>
<StartingLongitude>4.1</StartingLongitude>
<VehicleGUID>71d8f712-5349-4b38-a439-065b6452c47c</VehicleGUID>
</ClsRouteOptimization.ClsRouteOptimizationVehicle>
<ClsRouteOptimization.ClsRouteOptimizationVehicle>
<Capacity>2.1</Capacity>
<EndingLatitude>5.1</EndingLatitude>
<EndingLongitude>6.1</EndingLongitude>
<StartingLatitude>3.1</StartingLatitude>
<StartingLongitude>4.1</StartingLongitude>
<VehicleGUID>71d8f712-5349-4b38-a439-065b6452c47c</VehicleGUID>
</ClsRouteOptimization.ClsRouteOptimizationVehicle>
</Vehicles>
<Version>3</Version>
</ClsRouteOptimization>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Returns a list of destinations in an optimized order.
AgvRouteOptimization| Name | Description | Type | Additional Information |
|---|---|---|---|
| Status |
0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful. |
string | |
| Message |
Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know. |
string | |
| Count |
Count of how many Route JSON dictionaries. |
string | |
| Routes |
JSON dictionary of Route. |
Collection of ClsRouteOptimizationRoute |
Response Formats
application/json, text/json
Sample:
{
"Status": "sample string 1",
"Message": "sample string 2",
"Count": "2",
"Routes": [
{
"Vehicle": {
"VehicleID": "sample string 1"
},
"Stops": [
{
"StopType": 0,
"StopID": "sample string 1",
"PositionInRoute": 2,
"Quantity": 3.1,
"Priority": 4
},
{
"StopType": 0,
"StopID": "sample string 1",
"PositionInRoute": 2,
"Quantity": 3.1,
"Priority": 4
}
],
"RouteOptimizationGUID": "5ad906e4-60a3-4574-9018-969ea0a61673"
},
{
"Vehicle": {
"VehicleID": "sample string 1"
},
"Stops": [
{
"StopType": 0,
"StopID": "sample string 1",
"PositionInRoute": 2,
"Quantity": 3.1,
"Priority": 4
},
{
"StopType": 0,
"StopID": "sample string 1",
"PositionInRoute": 2,
"Quantity": 3.1,
"Priority": 4
}
],
"RouteOptimizationGUID": "5ad906e4-60a3-4574-9018-969ea0a61673"
}
]
}
application/xml, text/xml
Sample:
<AgvRouteOptimization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.RouteOptimization">
<Message>sample string 2</Message>
<Routes xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Interfaces.RouteOptimization">
<d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute>
<d2p1:RouteOptimizationGUID>5ad906e4-60a3-4574-9018-969ea0a61673</d2p1:RouteOptimizationGUID>
<d2p1:Stops>
<d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute.Stop>
<d2p1:PositionInRoute>2</d2p1:PositionInRoute>
<d2p1:Priority>4</d2p1:Priority>
<d2p1:Quantity>3.1</d2p1:Quantity>
<d2p1:StopID>sample string 1</d2p1:StopID>
<d2p1:StopType>Unknown</d2p1:StopType>
</d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute.Stop>
<d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute.Stop>
<d2p1:PositionInRoute>2</d2p1:PositionInRoute>
<d2p1:Priority>4</d2p1:Priority>
<d2p1:Quantity>3.1</d2p1:Quantity>
<d2p1:StopID>sample string 1</d2p1:StopID>
<d2p1:StopType>Unknown</d2p1:StopType>
</d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute.Stop>
</d2p1:Stops>
<d2p1:Vehicle>
<d2p1:VehicleID>sample string 1</d2p1:VehicleID>
</d2p1:Vehicle>
</d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute>
<d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute>
<d2p1:RouteOptimizationGUID>5ad906e4-60a3-4574-9018-969ea0a61673</d2p1:RouteOptimizationGUID>
<d2p1:Stops>
<d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute.Stop>
<d2p1:PositionInRoute>2</d2p1:PositionInRoute>
<d2p1:Priority>4</d2p1:Priority>
<d2p1:Quantity>3.1</d2p1:Quantity>
<d2p1:StopID>sample string 1</d2p1:StopID>
<d2p1:StopType>Unknown</d2p1:StopType>
</d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute.Stop>
<d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute.Stop>
<d2p1:PositionInRoute>2</d2p1:PositionInRoute>
<d2p1:Priority>4</d2p1:Priority>
<d2p1:Quantity>3.1</d2p1:Quantity>
<d2p1:StopID>sample string 1</d2p1:StopID>
<d2p1:StopType>Unknown</d2p1:StopType>
</d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute.Stop>
</d2p1:Stops>
<d2p1:Vehicle>
<d2p1:VehicleID>sample string 1</d2p1:VehicleID>
</d2p1:Vehicle>
</d2p1:ClsRouteOptimization.ClsRouteOptimizationRoute>
</Routes>
<Status>sample string 1</Status>
</AgvRouteOptimization>