GET API/JobTrak/UPRNCollections/{uprn}?includeUnsubscribed={includeUnsubscribed}
Get the collection dates of a given UPRN over a 12 month period
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
uprn |
UPRN to query |
string |
Required |
includeUnsubscribed |
Whether or not to include unsubscribed properties |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of NextCollectionDateName | Description | Type | Additional information |
---|---|---|---|
UPRN |
UPRN of Address |
string |
None. |
PropertyAddress |
Property Address (including postcode) |
string |
None. |
WasteType |
Waste Type |
string |
None. |
CollectionDay |
Collection Day |
string |
None. |
NextCollection |
Estimated next collection date. |
date |
None. |
WeekNumber |
Route Week Number |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "UPRN": "sample string 1", "PropertyAddress": "sample string 2", "WasteType": "sample string 3", "CollectionDay": "sample string 4", "NextCollection": "2025-04-29T18:14:48.2719747+01:00", "WeekNumber": 6 }, { "UPRN": "sample string 1", "PropertyAddress": "sample string 2", "WasteType": "sample string 3", "CollectionDay": "sample string 4", "NextCollection": "2025-04-29T18:14:48.2719747+01:00", "WeekNumber": 6 } ]
application/xml, text/xml
Sample:
<ArrayOfNextCollectionDate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <NextCollectionDate> <UPRN>sample string 1</UPRN> <PropertyAddress>sample string 2</PropertyAddress> <WasteType>sample string 3</WasteType> <CollectionDay>sample string 4</CollectionDay> <NextCollection>2025-04-29T18:14:48.2719747+01:00</NextCollection> <WeekNumber>6</WeekNumber> </NextCollectionDate> <NextCollectionDate> <UPRN>sample string 1</UPRN> <PropertyAddress>sample string 2</PropertyAddress> <WasteType>sample string 3</WasteType> <CollectionDay>sample string 4</CollectionDay> <NextCollection>2025-04-29T18:14:48.2719747+01:00</NextCollection> <WeekNumber>6</WeekNumber> </NextCollectionDate> </ArrayOfNextCollectionDate>