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 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
  1. Municipal

call the GetAddresses operation.

POST
/getaddresses
wsdemo-merge-uat-rest
Returns available addresses in Whitespace based on address parameters provided.
Commonly used call for webservices and system UPRN lookups.
Results can be returned as an array if more than one result is found.
SiteShortAddress in response almost always starts with a comma. Ignoring the comma at the beginning has been problematic for some developers. Recommend subsequent fields are concatenated if this causes an issue; OR Preference may be to run a subsequent GetSiteInfo or GetSiteContacts calls to get alternative Address strings.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/getaddresses' \
--header 'Content-Type: application/json' \
--header 'X-DreamFactory-API-Key;' \
--data-raw '{
    "getAddressInput": {
        "AddressNameNumber": "string",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "Town": "string",
        "County": "string",
        "Country": "string",
        "Postcode": "string",
        "IncludeCommercialSites": true
    }
}'
Response Response Example
200 - Example 1
{
    "GetAddressesResult": {
        "Addresses": {
            "Address": {
                "SiteShortAddress": "string",
                "SiteName": "string",
                "SiteAddressName": "string",
                "SiteAddressPrefix": "string",
                "SiteAddressNumber": "string",
                "SiteAddress1": "string",
                "SiteAddress2": "string",
                "SiteTown": "string",
                "SiteCity": "string",
                "SiteCounty": "string",
                "SiteCountry": "string",
                "SitePostCode": "string",
                "SiteLatitude": 0,
                "SiteLongitude": 0,
                "SiteNorthing": 0,
                "SiteEasting": 0,
                "AccountSiteUprn": 0,
                "SiteId": 0,
                "AccountSiteId": 0
            }
        }
    }
}

Request

Authorization
API Key
Add parameter in header
X-DreamFactory-API-Key
Example:
X-DreamFactory-API-Key: ********************
or
Body Params application/json
getAddressInput
object (GetAddressInput) 
optional
AddressNameNumber
string 
optional
string
AddressLine1
string 
optional
string
AddressLine2
string 
optional
string
Town
string 
optional
string
County
string 
optional
string
Country
string 
optional
string
Postcode
string 
optional
string
IncludeCommercialSites
boolean 
optional
true or false
Examples

Responses

🟢200OK
application/json
GetAddressesResponse Response
Body
GetAddressesResult
object (AddressResponse) 
optional
Addresses
object (ArrayOfAddress) 
optional
🔴500Server Error
Modified at 2025-06-18 11:14:26
Previous
call the GetActiveAddresses operation.
Next
call the GetAddressesByCoordinatesRadius operation.
Built with