Whitespace APIs
  1. Worksheets
Whitespace APIs
  • Home
    • Welcome to the Whitespace API Developer Portal
  • Municipal REST
    • Municipal
      • Get resources for this service.
      • call the AddAoMRoundLogs operation.
      • call the AddAoMWorksheetLogs operation.
      • call the AddSiteAttachment operation.
      • call the AddSiteContact operation.
      • call the AddSiteLog operation.
      • call the AddSiteServiceItem operation.
      • call the AddSiteServiceItemRoundSchedule operation.
      • call the AddSiteServiceNotification operation.
      • call the AddWorksheetAttachment operation.
      • call the AddWorksheetNotes operation.
      • call the CancelWorksheet operation.
      • call the CreateWorksheet operation.
      • call the DeleteSiteContact operation.
      • call the DeleteSiteServiceItem operation.
      • call the DeleteSiteServiceItemRoundSchedule operation.
      • call the GetAccountSiteId operation.
      • call the GetActiveAddresses operation.
      • call the GetAddresses operation.
      • call the GetAddressesByCoordinatesRadius operation.
      • call the GetCollectionByUprnAndDate operation.
      • call the GetCollectionByUprnAndDatePlus operation.
      • call the GetCollectionSlots operation.
      • call the GetFullSiteCollections operation.
      • call the GetFullWorksheetDetails operation.
      • call the GetInCabLogs operation.
      • call the GetLogsSearch operation.
      • call the GetNotifications operation.
      • call the GetServices operation.
      • call the GetServiceItems operation.
      • call the GetSites operation.
      • call the GetSiteAttachments operation.
      • call the GetSiteAvailableRounds operation.
      • call the GetSiteCollections operation.
      • call the GetSiteCollectionExtraDetails operation.
      • call the GetSiteContacts operation.
      • call the GetSiteContracts operation.
      • call the GetSiteFlags operation.
      • call the GetSiteId operation.
      • call the GetSiteIncidents operation.
      • call the GetSiteInfo operation.
      • call the GetSiteLogs operation.
      • call the GetSiteNotifications operation.
      • call the GetSiteServiceItemRoundSchedules operation.
      • call the GetSiteWorksheets operation.
      • call the GetStreets operation.
      • call the GetWalkNumbers operation.
      • call the GetWorkflowStatusAndEvents operation.
      • call the GetWorksheetsByReference operation.
      • call the GetWorksheetAttachments operation.
      • call the GetWorksheetChargeMatrix operation.
      • call the GetWorksheetDetails operation.
      • call the GetWorksheetDetailEvents operation.
      • call the GetWorksheetDetailExtraInfoFields operation.
      • call the GetWorksheetDetailNotes operation.
      • call the GetWorksheetDetailServiceItems operation.
      • call the GetWorksheetExtraInfoFields operation.
      • call the GetWorksheetRoles operation.
      • call the GetWorksheetServiceItems operation.
      • call the HelloWorld operation.
      • call the ProgressWorkflow operation.
      • call the RaiseCancelWorksheetRequest operation.
      • call the UpdateSiteContact operation.
      • call the UpdateSiteServiceItem operation.
      • call the UpdateSiteServiceNotification operation.
      • call the UpdateWorkflowEventDate operation.
      • call the UpdateWorksheet operation.
  • Commercial REST
    • Contracts
      • get all contracts
      • Create Contract
      • get single contract
      • Ends a specific contract
      • Cancels a specific contract
      • Assign site services
      • Get all contract documents
      • Get all Collections by Contract
      • Upload a document for a given contract
      • Get Collection by id
      • Get the next available actions for a contract
      • Progress workflow associated with contract
    • Accounts
      • Get accounts - TBC
      • Create Account
      • Get account by Id
      • Update Account
      • Get all Sites belonging to account
      • Get all adhoc requests at account
      • Get all documents for an account
      • Get all Contracts by Account
    • Lookups
      • Get addresses
      • Get all SIC codes
      • Get all trading classifications
      • Gets all valid unit prices
      • Gets all valid adhoc unit prices
      • Get all Authorities
    • Sites
      • Get Site by id
      • Update Site
      • Get all adhoc requests at Site
      • Get all Contracts by Site
      • Get available collections days by site and waste stream
      • Get Site Contacts
      • Get Site Contact
      • Update Site Contacts
      • Create Site
      • Create Site Contact
      • Delete Site Contact
      • Get all contract discounts at the given site
      • Create a discount
      • Get a specific contract discount
      • Set end date for a contract discount
      • Delete a discount
      • Get specific adhoc discount at the given site
      • Get all adhoc discounts at the site
      • Create an adhoc discount
      • Set end date for an adhoc discount
      • Delete an adhoc discount
    • Worksheets
      • Create adhoc request
        POST
      • Get adhoc request by Id
        GET
      • Get adhoc request actions
        GET
      • Get all ad hoc request documents
        GET
      • Progress adhoc request actions
        POST
      • Upload a document for a given adhoc request
        POST
    • Waste Streams
      • Get all contract classification subtypes
      • Get all waste streams
      • Get all waste stream unit prices
      • Get all waste stream adhoc prices
      • Get all waste stream adhoc prices
      • Get all contract classifications
      • Get all payment methods
      • Get all collection items
      • Get all collection items
      • Get all payment frequencies
    • Adhoc Services
      • Gets all adhoc price classifications
      • Gets all adhoc services
      • Gets all adhoc items for a service
    • Collections
      • Assign site services
      • Get Collection by id
    • Discounts
      • Gets all contracts where a discount is applied
    • Documents
      • Gets a document
      • Delete a document Copy
      • Update a document
  1. Worksheets

Create adhoc request

POST
/v1/adhoc-requests
Worksheets
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/adhoc-requests' \
--header 'Content-Type: application/json' \
--data-raw '{
    "siteId": 0,
    "reference": "string",
    "adHocServiceId": 0,
    "adHocItems": [
        {
            "quantity": 1
        }
    ],
    "extraInfoFields": [
        {
            "id": 1,
            "value": "string"
        }
    ],
    "startdate": "2019-08-24T14:15:22Z"
}'
Response Response Example
201 - Example 1
{}

Request

Body Params application/json
siteId
integer 
required
The site Id the ad hoc request is to be raised against.
reference
string  | null 
optional
The optional reference of the ad hoc request. This has a maximum length of 20 characters.
<= 20 characters
adHocServiceId
integer 
required
The ad hoc service behind the ad hoc request.
adHocItems
array [object {1}] 
optional
The ad hoc items assigned to the ad hoc request.
quantity
integer <int32>
required
>= 1
Default:
1
extraInfoFields
array [object {2}] 
optional
The extra info fields assigned to the ad hoc request.
id
integer 
Extra Info ID
required
The unique identifier for the extra info field as stored in the Whitespace database. This is an auto-incremented integer field.
Example:
1
value
string  | null 
optional
The value of the extra info field.
<= 2000 characters
startdate
string <date-time>
required
The start date for the ad hoc request.
Examples

Responses

🟢201Created
application/json
Headers
Location
string 
optional
Example:
/v1/adhoc-requests/123
Body
object {0}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
Modified at 2025-06-19 07:14:18
Previous
Delete an adhoc discount
Next
Get adhoc request by Id
Built with