Mun REST
  1. Municipal
Mun 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 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
  • Worksheets
    • call the GetSiteWorksheets operation.
  1. Municipal

call the GetSites operation.

POST
/getsites
wsdemo-merge-uat-rest
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/getsites' \
--header 'Content-Type: application/json' \
--header 'X-DreamFactory-API-Key;' \
--data-raw '{
    "sitesInput": {
        "Uprn": "string"
    }
}'
Response Response Example
200 - Example 1
{
    "GetSitesResult": {
        "SiteArray": {
            "AccountSite": {
                "ExtensionData": {},
                "AccountSiteID": 0,
                "AccountSiteUPRN": 0,
                "BusinessTypeCode": "string",
                "BusinessTypeName": "string",
                "SalesZoneCode": "string",
                "SalesZoneName": "string",
                "AccountSiteStatusID": 0,
                "AccountSiteStatusName": "string",
                "AreaID": 0,
                "AreaName": "string",
                "AccountSiteTypeID": 0,
                "AccountSiteTypeName": "string",
                "ParishID": 0,
                "ParishName": "string",
                "WardID": 0,
                "WardName": "string",
                "NumChildren": 0,
                "Site": {
                    "ExtensionData": {},
                    "SiteID": 0,
                    "SiteName": "string",
                    "SiteAddressPrefix": "string",
                    "SiteAddressName": "string",
                    "SiteShortAddress": "string",
                    "SiteAddressNumber": "string",
                    "SiteAddress1": "string",
                    "SiteAddress2": "string",
                    "SiteTown": "string",
                    "SiteCity": "string",
                    "SiteCounty": "string",
                    "SiteCountry": "string",
                    "SitePostCode": "string",
                    "SiteReference": "string",
                    "AccountID": 0,
                    "AccountGroupCode": "string",
                    "AccountGroupName": "string",
                    "SiteCreatedDate": "string",
                    "SiteClosedDate": "string",
                    "SiteStoppedDate": "string",
                    "SiteLatitude": 0,
                    "SiteLongitude": 0,
                    "SiteNorthing": 0,
                    "SiteEasting": 0,
                    "ServiceChargeTypeID": 0,
                    "ServiceChargeTypeName": "string",
                    "StreetID": 0,
                    "StreetName": "string",
                    "SiteIsContract": true,
                    "SiteIsNonContract": true,
                    "SiteNoInvoice": true,
                    "SiteNotes": "string",
                    "SiteParentID": 0,
                    "AuthorityID": 0,
                    "SiteFullAddress": "string"
                }
            }
        }
    }
}

Request

Authorization
API Key
Add parameter in header
X-DreamFactory-API-Key
Example:
X-DreamFactory-API-Key: ********************
or
Body Params application/json
sitesInput
object (GetSitesInput) 
optional
Uprn
string 
optional
string
Examples

Responses

🟢200OK
application/json
GetSitesResponse Response
Body
GetSitesResult
object (SiteArrayResponse) 
optional
SiteArray
object (ArrayOfAccountSite) 
optional
🔴500Server Error
Modified at 2025-06-13 09:57:01
Previous
call the GetServiceItems operation.
Next
call the GetSiteAttachments operation.
Built with