POST API/JobTrak/ImportHaulageRoutes
Import route items to build routes. Items not included will be removed from the route
Request Information
URI Parameters
None.
Body Parameters
Route items to include
Collection of HaulageRouteImportItem| Name | Description | Type | Additional information |
|---|---|---|---|
| RouteIdentifier |
Name of the route to appear on |
string |
Required |
| LoginId |
Assigned vehicle registation or Login ID |
string |
Required |
| DayOfWeek |
Collection day of week ("0" for Ad-hoc, "1-7" for Monday-Sunday) |
WeekDay |
Required |
| WeekNumber |
Week number (1, 2, 3 or 4) |
integer |
Required |
| CollectionSequence |
Collection sequence |
integer |
Required |
| JobReference |
Job Reference |
string |
Required |
Request Formats
application/json, text/json
Sample:
[
{
"RouteIdentifier": "sample string 1",
"LoginId": "sample string 2",
"DayOfWeek": 0,
"WeekNumber": 3,
"CollectionSequence": 4,
"JobReference": "sample string 5"
},
{
"RouteIdentifier": "sample string 1",
"LoginId": "sample string 2",
"DayOfWeek": 0,
"WeekNumber": 3,
"CollectionSequence": 4,
"JobReference": "sample string 5"
}
]
application/xml, text/xml
Sample:
<ArrayOfHaulageRouteImportItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<HaulageRouteImportItem>
<RouteIdentifier>sample string 1</RouteIdentifier>
<LoginId>sample string 2</LoginId>
<DayOfWeek>Adhoc</DayOfWeek>
<WeekNumber>3</WeekNumber>
<CollectionSequence>4</CollectionSequence>
<JobReference>sample string 5</JobReference>
</HaulageRouteImportItem>
<HaulageRouteImportItem>
<RouteIdentifier>sample string 1</RouteIdentifier>
<LoginId>sample string 2</LoginId>
<DayOfWeek>Adhoc</DayOfWeek>
<WeekNumber>3</WeekNumber>
<CollectionSequence>4</CollectionSequence>
<JobReference>sample string 5</JobReference>
</HaulageRouteImportItem>
</ArrayOfHaulageRouteImportItem>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.