Both staff and public users can report missed collections for rounds that meet the set business logic. Reasons are given for rounds that can't be reported as missed.
Reporting Missed Collections
Collections eligible to be reported as missing are listed as a series of checkboxes.
Once a collection has been reported as missing the user will see a confirmation message that includes the business key of the corresponding process instance, which can be used as a reference number to track the report.
Collections that can't be Reported
Most collection providers set rules for which types of collection can be reported. Example rules may include:
- Is this type of collection active at this property?
- Has the collection round finished?
- Is the report being raised within a valid time period?
- Were the bins put out?
- Was there an excess or any unacceptable waste?
- Is there an existing report?
Missed Rounds Schema
Responsible for returning all address rounds associated with a property, and checking whether or not they can be reported as missing. Full technical information about the End Points and schema used for missed rounds 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 | |
addressRounds | A list of address rounds | Yes | Array of objects | |
Uprn | The UPRN of the property | String | ||
roundId | The ID/name of the addressRound from the provider | String | ||
Type | Waste type - i.e. "Food", "Recycling" | String | ||
Frequency | How often it is collected - i.e. "14 days" | String | ||
previousCollectionDate | The last collection date | Date | ||
nextCollectionDate | The next collection date | Date | ||
roundEndDate | The date of the round's expiry | Date | ||
missSR | Status of the missed service request, if any | String | ||
inServiceBins | Are there bins active on this service? | Boolean | ||
Events | Array of event objects | Obj Array | ||
Status | Status of the round/bins - i.e. "IN SERVICE" | String | ||
businessRuleFailures | Array of integers, keeping track of which business rules the addressRound failed on | Int Array | ||
canReportMissing | Can the collection be reported as missed? | Boolean | ||
cannotReportMessage | Array of strings, containing readable alternatives to businessRuleFailures array | Str Array | ||
optionGroupArray | If any schedules can be reported, they will populate this array. Formatted as a drop-down list: | Yes | Array | |
i.e. "Food Waste 23L" | String | |||
i.e. "Food. This was last due for collection on Friday 8th June 2018" | String | |||
Empty | String |
Start Workflow
Once a user has reported a missed bin 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.