POST API/JobTrak/ImportTradeRoute

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 TradeRouteItem

Name	Description	Type	Additional information
RouteIdentifier	Name of the route to appear on	string	Required
LoginId	Assigned vehicle registation or Login ID	string	None.
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
CustomerAssetID	Customer Bin unique identifier (Acquired from /JobTrak/GetCustomerBins)	integer	None.
PropertySpecialInstructions	Property Special Instructions	string	None.
BinTag	Customer Bin Tag	string	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ArrayOfTradeRouteItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TradeRouteItem>
    <RouteIdentifier>sample string 1</RouteIdentifier>
    <LoginId>sample string 2</LoginId>
    <DayOfWeek>Adhoc</DayOfWeek>
    <WeekNumber>3</WeekNumber>
    <CollectionSequence>4</CollectionSequence>
    <CustomerAssetID>1</CustomerAssetID>
    <PropertySpecialInstructions>sample string 5</PropertySpecialInstructions>
    <BinTag>sample string 6</BinTag>
  </TradeRouteItem>
  <TradeRouteItem>
    <RouteIdentifier>sample string 1</RouteIdentifier>
    <LoginId>sample string 2</LoginId>
    <DayOfWeek>Adhoc</DayOfWeek>
    <WeekNumber>3</WeekNumber>
    <CollectionSequence>4</CollectionSequence>
    <CustomerAssetID>1</CustomerAssetID>
    <PropertySpecialInstructions>sample string 5</PropertySpecialInstructions>
    <BinTag>sample string 6</BinTag>
  </TradeRouteItem>
</ArrayOfTradeRouteItem>

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 'TradeRouteItem[]'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.