Garden waste collections are typically paid-for services subscribed to on an annual basis. Users are able to check their current subscription and sign up for this or the following year.
Subscription Information
Once a user has looked up an address, they'll see a number of options depending on whether the property is eligible for the service and whether or not a previous subscription exists.
If a property has a subscription, its details are displayed. A configurable cut-off date is set in the configuration to determine if which subscriptions are "previous" or "current".
Garden Waste Schema
Responsible for returning the previous and next garden waste subscriptions. Full technical information about the End Points and schema used for subscriptions can be found in the Waste Services Specification document.
Request
| Parameter Name | Description | Required | Type |
|---|---|---|---|
| UPRN | The UPRN of the selected property | Yes | String |
Return
| Parameter name | Property Name | Description | Required | Type |
|---|---|---|---|---|
| Success | Whether the API call was successful | Yes | Boolean | |
| binCharge | The charge for a single garden waste bin | Yes | Float | |
| selectedAddress | The address for the selected property | Yes | Object | |
| Uprn | The UPRN of the property | String | ||
| Usrn | Universal street reference number | String | ||
| fullAddress | Full address, formatted on one line | String | ||
| lastSubscription | The previous year's subscription. If one doesn't exist, it will use default values | Yes | Object | |
| Reference | A property attribute from the provider: "Reference Number" | String | ||
| subscriptionYear | The starting year for the subscription | Integer | ||
| numBins | How many bins are on the subscription | Integer | ||
| Uprn | The UPRN of the property | String | ||
| yearlyCharge | DEPRECATED - the charge is per bin | Float | ||
| yearStartDate | The (formatted) starting date for the subscription | String | ||
| yearEndDate | The (formatted) end date for the subscription | String | ||
| reminderDate | NOT USED. | String | ||
| sacksProperty | Is the property in receipt of garden waste sacks? | Boolean | ||
| nextSubscription | The next year's subscription. If one doesn't exist, it will use default values | Yes | Object | |
| Reference | A property attribute from the provider: "Reference Number" | String | ||
| subscriptionYear | The starting year for the subscription | Integer | ||
| numBins | How many bins are on the subscription | Integer | ||
| Uprn | The UPRN of the property | String | ||
| yearlyCharge | DEPRECATED - the charge is per bin | Float | ||
| yearStartDate | The (formatted) starting date for the subscription | String | ||
| yearEndDate | The (formatted) end date for the subscription | String | ||
| reminderDate | NOT USED. | String | ||
| sacksProperty | Is the property in receipt of garden waste sacks? | Boolean |
Subscribing to Garden Waste Services
Once users have made a selection they are typically presented with a summary and inputs to enter their contact details. This part of the process is handled entirely by our platform and can include redirection to any of the standard supported payment providers.
Once payment has been confirmed a workflow starts which creates a service request in the provider's system. Typically notification emails are also sent and records are added to a report history.
Share this page
