POST API/JobTrak/ImportDomesticRoute

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 DomesticRouteItem

Name	Description	Type	Additional information
RouteIdentifier	Name of the route to appear on	string	Required
RouteType	The type of route ("D" = Domestic, "T" = Trade)	string	Required
Vehicle	Assigned vehicle registation	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
StreetCollectionSequence	Street collection sequence	integer	Required
PropertyCollectionSequence	Property collection sequence	integer	None.
UPRN	UPRN - Unique Property Reference Number	string	Required
PropertyNameOrNumber	Property number or name	string	Required
StreetName	Street Name	string	Required
USRN	USRN - Unique Street Reference Number	string	Required
Locality	Locality	string	None.
Town	Town	string	None.
PostCode	Postal Code	string	None.
Easting	Easting coordinates (must be paired with Northing)	decimal number	None.
Northing	Northing coordinates (must be paired with Easting)	decimal number	None.
Latitude	Latitude coordinates (must be paired with Longitude)	decimal number	None.
Longitude	Longitude coordinates (must be paired with Latitude)	decimal number	None.
PropertySpecialInstructions	Property Special Instructions	string	None.
AssistedCollection	Assited collection required (true/false or 1/0 for yes/no)	boolean	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "RouteIdentifier": "sample string 1",
    "RouteType": "sample string 2",
    "Vehicle": "sample string 3",
    "DayOfWeek": 0,
    "WeekNumber": 4,
    "StreetCollectionSequence": 5,
    "PropertyCollectionSequence": 1,
    "UPRN": "sample string 6",
    "PropertyNameOrNumber": "sample string 7",
    "StreetName": "sample string 8",
    "USRN": "sample string 9",
    "Locality": "sample string 10",
    "Town": "sample string 11",
    "PostCode": "sample string 12",
    "Easting": 1.1,
    "Northing": 1.1,
    "Latitude": 1.1,
    "Longitude": 1.1,
    "PropertySpecialInstructions": "sample string 13",
    "AssistedCollection": true
  },
  {
    "RouteIdentifier": "sample string 1",
    "RouteType": "sample string 2",
    "Vehicle": "sample string 3",
    "DayOfWeek": 0,
    "WeekNumber": 4,
    "StreetCollectionSequence": 5,
    "PropertyCollectionSequence": 1,
    "UPRN": "sample string 6",
    "PropertyNameOrNumber": "sample string 7",
    "StreetName": "sample string 8",
    "USRN": "sample string 9",
    "Locality": "sample string 10",
    "Town": "sample string 11",
    "PostCode": "sample string 12",
    "Easting": 1.1,
    "Northing": 1.1,
    "Latitude": 1.1,
    "Longitude": 1.1,
    "PropertySpecialInstructions": "sample string 13",
    "AssistedCollection": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfDomesticRouteItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DomesticRouteItem>
    <RouteIdentifier>sample string 1</RouteIdentifier>
    <RouteType>sample string 2</RouteType>
    <Vehicle>sample string 3</Vehicle>
    <DayOfWeek>Adhoc</DayOfWeek>
    <WeekNumber>4</WeekNumber>
    <StreetCollectionSequence>5</StreetCollectionSequence>
    <PropertyCollectionSequence>1</PropertyCollectionSequence>
    <UPRN>sample string 6</UPRN>
    <PropertyNameOrNumber>sample string 7</PropertyNameOrNumber>
    <StreetName>sample string 8</StreetName>
    <USRN>sample string 9</USRN>
    <Locality>sample string 10</Locality>
    <Town>sample string 11</Town>
    <PostCode>sample string 12</PostCode>
    <Easting>1.1</Easting>
    <Northing>1.1</Northing>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <PropertySpecialInstructions>sample string 13</PropertySpecialInstructions>
    <AssistedCollection>true</AssistedCollection>
  </DomesticRouteItem>
  <DomesticRouteItem>
    <RouteIdentifier>sample string 1</RouteIdentifier>
    <RouteType>sample string 2</RouteType>
    <Vehicle>sample string 3</Vehicle>
    <DayOfWeek>Adhoc</DayOfWeek>
    <WeekNumber>4</WeekNumber>
    <StreetCollectionSequence>5</StreetCollectionSequence>
    <PropertyCollectionSequence>1</PropertyCollectionSequence>
    <UPRN>sample string 6</UPRN>
    <PropertyNameOrNumber>sample string 7</PropertyNameOrNumber>
    <StreetName>sample string 8</StreetName>
    <USRN>sample string 9</USRN>
    <Locality>sample string 10</Locality>
    <Town>sample string 11</Town>
    <PostCode>sample string 12</PostCode>
    <Easting>1.1</Easting>
    <Northing>1.1</Northing>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <PropertySpecialInstructions>sample string 13</PropertySpecialInstructions>
    <AssistedCollection>true</AssistedCollection>
  </DomesticRouteItem>
</ArrayOfDomesticRouteItem>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.