GET API/JobTrak/Domestic/UprnExport/{uprn}

Get route data for a given UPRN

Request Information

URI Parameters

Name	Description	Type	Additional information
uprn	UPRN to query, or "all" to retreive all UPRNs	string	Required

Body Parameters

None.

Response Information

Resource Description

UPRN route data

Collection of UprnRouteData

Name	Description	Type	Additional information
Uprn	UPRN	string	None.
RouteIdentifier	Route Identifier	string	None.
NameOrNumber	UPRN Name or Number	string	None.
Address	UPRN Address	Address	None.
ContentType	Route Content Type	string	None.
AssetQuantity	Route UPRN Asset Quantity	integer	None.
SpecialInstructions	Route Special Instructions	string	None.
AssistedCollection	Assisted Collection	boolean	None.
AssistedCollectionInstructions	Assisted Collection Information	string	None.
Subscribed	UPRN Route Subrcription Status	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Uprn": "sample string 1",
    "RouteIdentifier": "sample string 2",
    "NameOrNumber": "sample string 3",
    "Address": {
      "Street": "sample string 1",
      "Region": "sample string 2",
      "Town": "sample string 3",
      "District": "sample string 4",
      "County": "sample string 5",
      "Postcode": "sample string 6",
      "Country": "sample string 7",
      "Label": "sample string 1, sample string 4, sample string 3, sample string 5, sample string 6, sample string 7",
      "Empty": false
    },
    "ContentType": "sample string 4",
    "AssetQuantity": 5,
    "SpecialInstructions": "sample string 6",
    "AssistedCollection": true,
    "AssistedCollectionInstructions": "sample string 8",
    "Subscribed": false
  },
  {
    "Uprn": "sample string 1",
    "RouteIdentifier": "sample string 2",
    "NameOrNumber": "sample string 3",
    "Address": {
      "Street": "sample string 1",
      "Region": "sample string 2",
      "Town": "sample string 3",
      "District": "sample string 4",
      "County": "sample string 5",
      "Postcode": "sample string 6",
      "Country": "sample string 7",
      "Label": "sample string 1, sample string 4, sample string 3, sample string 5, sample string 6, sample string 7",
      "Empty": false
    },
    "ContentType": "sample string 4",
    "AssetQuantity": 5,
    "SpecialInstructions": "sample string 6",
    "AssistedCollection": true,
    "AssistedCollectionInstructions": "sample string 8",
    "Subscribed": false
  }
]

application/xml, text/xml

Sample:

<ArrayOfUprnRouteData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UprnRouteData>
    <Uprn>sample string 1</Uprn>
    <RouteIdentifier>sample string 2</RouteIdentifier>
    <NameOrNumber>sample string 3</NameOrNumber>
    <Address>
      <Street>sample string 1</Street>
      <Region>sample string 2</Region>
      <Town>sample string 3</Town>
      <District>sample string 4</District>
      <County>sample string 5</County>
      <Postcode>sample string 6</Postcode>
      <Country>sample string 7</Country>
    </Address>
    <ContentType>sample string 4</ContentType>
    <AssetQuantity>5</AssetQuantity>
    <SpecialInstructions>sample string 6</SpecialInstructions>
    <AssistedCollection>true</AssistedCollection>
    <AssistedCollectionInstructions>sample string 8</AssistedCollectionInstructions>
    <Ignore>true</Ignore>
  </UprnRouteData>
  <UprnRouteData>
    <Uprn>sample string 1</Uprn>
    <RouteIdentifier>sample string 2</RouteIdentifier>
    <NameOrNumber>sample string 3</NameOrNumber>
    <Address>
      <Street>sample string 1</Street>
      <Region>sample string 2</Region>
      <Town>sample string 3</Town>
      <District>sample string 4</District>
      <County>sample string 5</County>
      <Postcode>sample string 6</Postcode>
      <Country>sample string 7</Country>
    </Address>
    <ContentType>sample string 4</ContentType>
    <AssetQuantity>5</AssetQuantity>
    <SpecialInstructions>sample string 6</SpecialInstructions>
    <AssistedCollection>true</AssistedCollection>
    <AssistedCollectionInstructions>sample string 8</AssistedCollectionInstructions>
    <Ignore>true</Ignore>
  </UprnRouteData>
</ArrayOfUprnRouteData>