GET api/Dispatch/GetRouteCodes/{auth}
Use this method to get a list of route codes for the users office
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
auth |
Unique authorization identifier |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
GetRouteCodesRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Set to true if method was successful |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
RouteCodes |
List of route codes |
Collection of RouteCode |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2", "RouteCodes": null }
application/xml, text/xml
Sample:
<GetRouteCodesResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <RouteCodes i:nil="true" /> </GetRouteCodesResp>