Whitespace
Integration with the "WhiteSpace" waste management platform so that clients can check on missed bin errors and create cases to get them resolved.
Setup
WhiteSpace require to have SinglePoint marketplace installed and set. It is used to collect UPRN from user, which is then used for WhiteSpace lookup.
Blocks Provided
Provide a list of the blocks provided as part of this integration. This should be a list of block name, and its description.
| Block Name | Purpose |
|---|---|
| whitespace-missing-auth | Provides a default message to display when the username and password are not set as function args |
| whitespace-missing-date | Provides a default message to display when user input date not provided to form |
| whitespace-missing-uprn | Provides a default message to display when user doesn't have UPRN ( require singlepoint integration) |
| next-collection-function | This will lookup next collections based on UPRN and current date |
| missed-bin-function | It will do checking on missed collection and allow you to report missed bin |
| create-worksheet-function | Based on Worksheet Service ID you can create various worksheet |
| get-service-item-function | This will lookup services at the property based on UPRN to raise missed collection against |
| get-available-slots-function | This will lookup for available slots needed to create bulky waste worksheet |
Handler Names
The following handler names and their functions are available :
| Handler Name | Purpose |
|---|---|
| next-collection | Searches for next collections based on the user wbb-singlepoint-uprn variable ( SinglePoint ) and current date |
| missed-bin | It will do checking based chosen service and missed bin date, if all is fine it will create missed bin worksheet |
| get-service-items | It will lookup services at the property based on UPRN |
Configuration Options
( Provide a list of the configuration options for each of the handlers mentioned above )
Within the function there are a number of options that can be set to configure the behaviour of the integration. The tables below show the settings that are available for each handler.
next-collection
| Property | Required | Description |
|---|---|---|
| username | true | used to access WhiteSpace API |
| password | true | used to access WhiteSpace API |
missed-bin
| Property | Required | Description |
|---|---|---|
| username | true | used to access WhiteSpace API |
| password | true | used to access WhiteSpace API |
get-service-items
| Property | Required | Description |
|---|---|---|
| username | true | used to access WhiteSpace API |
| password | true | used to access WhiteSpace API |