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
NameDescriptionTypeAdditional information
RouteIdentifier

Name of the route to appear on

string

Required

PropertyCode

Property Code (Used as unique Identifier)

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

PropertySpecialInstructions

Property Special Instructions

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "RouteIdentifier": "sample string 1",
    "PropertyCode": "sample string 2",
    "LoginId": "sample string 3",
    "DayOfWeek": 0,
    "WeekNumber": 4,
    "CollectionSequence": 5,
    "PropertySpecialInstructions": "sample string 6"
  },
  {
    "RouteIdentifier": "sample string 1",
    "PropertyCode": "sample string 2",
    "LoginId": "sample string 3",
    "DayOfWeek": 0,
    "WeekNumber": 4,
    "CollectionSequence": 5,
    "PropertySpecialInstructions": "sample string 6"
  }
]

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>
    <PropertyCode>sample string 2</PropertyCode>
    <LoginId>sample string 3</LoginId>
    <DayOfWeek>Adhoc</DayOfWeek>
    <WeekNumber>4</WeekNumber>
    <CollectionSequence>5</CollectionSequence>
    <PropertySpecialInstructions>sample string 6</PropertySpecialInstructions>
  </HaulageRouteImportItem>
  <HaulageRouteImportItem>
    <RouteIdentifier>sample string 1</RouteIdentifier>
    <PropertyCode>sample string 2</PropertyCode>
    <LoginId>sample string 3</LoginId>
    <DayOfWeek>Adhoc</DayOfWeek>
    <WeekNumber>4</WeekNumber>
    <CollectionSequence>5</CollectionSequence>
    <PropertySpecialInstructions>sample string 6</PropertySpecialInstructions>
  </HaulageRouteImportItem>
</ArrayOfHaulageRouteImportItem>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.