Whitespace APIs
  1. Municipal
Whitespace APIs
  • Home
    • Welcome to the Whitespace API Developer Portal
  • Municipal REST
    • Municipal
      • Get resources for this service.
        GET
      • call the AddAoMRoundLogs operation.
        POST
      • call the AddAoMWorksheetLogs operation.
        POST
      • call the AddSiteAttachment operation.
        POST
      • call the AddSiteContact operation.
        POST
      • call the AddSiteLog operation.
        POST
      • call the AddSiteServiceItem operation.
        POST
      • call the AddSiteServiceItemRoundSchedule operation.
        POST
      • call the AddSiteServiceNotification operation.
        POST
      • call the AddWorksheetAttachment operation.
        POST
      • call the AddWorksheetNotes operation.
        POST
      • call the CancelWorksheet operation.
        POST
      • call the CreateWorksheet operation.
        POST
      • call the DeleteSiteContact operation.
        POST
      • call the DeleteSiteServiceItem operation.
        POST
      • call the DeleteSiteServiceItemRoundSchedule operation.
        POST
      • call the GetAccountSiteId operation.
        POST
      • call the GetActiveAddresses operation.
        POST
      • call the GetAddresses operation.
        POST
      • call the GetAddressesByCoordinatesRadius operation.
        POST
      • call the GetCollectionByUprnAndDate operation.
        POST
      • call the GetCollectionByUprnAndDatePlus operation.
        POST
      • call the GetCollectionSlots operation.
        POST
      • call the GetFullSiteCollections operation.
        POST
      • call the GetFullWorksheetDetails operation.
        POST
      • call the GetInCabLogs operation.
        POST
      • call the GetLogsSearch operation.
        POST
      • call the GetNotifications operation.
        POST
      • call the GetServices operation.
        POST
      • call the GetServiceItems operation.
        POST
      • call the GetSites operation.
        POST
      • call the GetSiteAttachments operation.
        POST
      • call the GetSiteAvailableRounds operation.
        POST
      • call the GetSiteCollections operation.
        POST
      • call the GetSiteCollectionExtraDetails operation.
        POST
      • call the GetSiteContacts operation.
        POST
      • call the GetSiteContracts operation.
        POST
      • call the GetSiteFlags operation.
        POST
      • call the GetSiteId operation.
        POST
      • call the GetSiteIncidents operation.
        POST
      • call the GetSiteInfo operation.
        POST
      • call the GetSiteLogs operation.
        POST
      • call the GetSiteNotifications operation.
        POST
      • call the GetSiteServiceItemRoundSchedules operation.
        POST
      • call the GetSiteWorksheets operation.
        POST
      • call the GetStreets operation.
        POST
      • call the GetWalkNumbers operation.
        POST
      • call the GetWorkflowStatusAndEvents operation.
        POST
      • call the GetWorksheetsByReference operation.
        POST
      • call the GetWorksheetAttachments operation.
        POST
      • call the GetWorksheetChargeMatrix operation.
        POST
      • call the GetWorksheetDetails operation.
        POST
      • call the GetWorksheetDetailEvents operation.
        POST
      • call the GetWorksheetDetailExtraInfoFields operation.
        POST
      • call the GetWorksheetDetailNotes operation.
        POST
      • call the GetWorksheetDetailServiceItems operation.
        POST
      • call the GetWorksheetExtraInfoFields operation.
        POST
      • call the GetWorksheetRoles operation.
        POST
      • call the GetWorksheetServiceItems operation.
        POST
      • call the HelloWorld operation.
        POST
      • call the ProgressWorkflow operation.
        POST
      • call the RaiseCancelWorksheetRequest operation.
        POST
      • call the UpdateSiteContact operation.
        POST
      • call the UpdateSiteServiceItem operation.
        POST
      • call the UpdateSiteServiceNotification operation.
        POST
      • call the UpdateWorkflowEventDate operation.
        POST
      • call the UpdateWorksheet operation.
        POST
  • 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
      • Get adhoc request by Id
      • Get adhoc request actions
      • Get all ad hoc request documents
      • Progress adhoc request actions
      • Upload a document for a given adhoc request
    • 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. Municipal

call the GetSiteContracts operation.

POST
/getsitecontracts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/getsitecontracts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sitecontractInput": {
        "IncludeCommercial": true
    }
}'
Response Response Example
200 - Example 1
{
    "GetSiteContractsResult": {
        "SiteContracts": {
            "SiteContract": {
                "ExtensionData": {},
                "SiteContractID": 0,
                "SiteID": 0,
                "AccountSiteID": 0,
                "ContractID": 0,
                "ContractTypeID": 0,
                "ContractTypeName": "string",
                "ContractStatusCode": "string",
                "ContractStatusDescription": "string",
                "ContractName": "string",
                "SiteContractValidFrom": "2019-08-24T14:15:22Z",
                "SiteContractValidTo": "2019-08-24T14:15:22Z",
                "ScheduleID": 0,
                "ScheduleName": "string",
                "PaymentMethodID": 0,
                "PaymentMethodName": "string",
                "SiteContractGUID": "string",
                "ContractReference": "string",
                "ContractPONumber": "string",
                "SiteContractNotes": "string",
                "SiteAddress": "string",
                "SelectedEndDate": "2019-08-24T14:15:22Z",
                "InvoiceToDate": "2019-08-24T14:15:22Z",
                "WorkflowInstanceID": 0,
                "InstanceGuid": "string",
                "WorkflowFileID": 0,
                "WorkflowFileName": "string",
                "InstanceCurrentState": "string"
            }
        }
    }
}

Request

Body Params application/json
sitecontractInput
object (GetSiteContractInput) 
optional
IncludeCommercial
boolean 
optional
true or false
Examples

Responses

🟢200OK
application/json
GetSiteContractsResponse Response
Body
GetSiteContractsResult
object (SiteContractResponse) 
optional
SiteContracts
object (ArrayOfSiteContract) 
optional
🔴500Server Error
Modified at 2025-06-18 14:52:19
Previous
call the GetSiteContacts operation.
Next
call the GetSiteFlags operation.
Built with