Most calls to the framework start with an address search by postcode. This returns the property UPRN, which is used in subsequent calls to look up collection days, report missed collections, request new bins, and subscribe to additional services.
Search by Postcode
Staff and public users both use a similar interface for looking up addresses. The postcode is passed to the provider's API and matching addresses are displayed in a list.
Form validation ensures the postcode is entered in a format the API understands, and friendly error messages displayed if the postcode is invalid, or no matching address could be found.
Address Search Schema
Full technical information about the End Points and schema used for address searches can be found in the Waste Services Specification document.
Request
| Parameter Name | Description | Required | Type |
|---|---|---|---|
| Postcode | The postcode to search for. This is optional to suppress errors when first accessing (and therefore calling) the postcode search function when the postcode field is empty. | No | String |
Return
| Parameter Name | Property Name | Description | Required | Type |
|---|---|---|---|---|
| Success | Whether the operation was successful | Yes | Boolean | |
| Statistics | A descriptive message indicating how many addresses were found under the given postcode | Yes | String | |
| Addresses | An array of an array of the following fields, formatted for an iCM drop-down list | Yes | Array | |
| UPRN | The UPRN of the property | String | ||
| Address Line 1 | First line of the address | String | ||
| City | The address city | String | ||
| showResults | Whether one or more results were found | Yes | Boolean |
Share this page
