Mercedes.Agency.Orchestration.API

<back to all web services

GetAddressRequest

Address
Requires Authentication
The following routes are available for this service:
GET/v1/address/{Postcode}Get Address by PostCode
GET/v1/address/{Postcode}/{HouseNameOrNumber}Get Address by PostCode and Premise
GetAddressRequest Parameters:
NameParameterData TypeRequiredDescription
PostcodepathstringYes
HouseNameOrNumberpathstringYes
GetAddressResponse Parameters:
NameParameterData TypeRequiredDescription
AddressesformList<Address>Yes
Address Parameters:
NameParameterData TypeRequiredDescription
PropertyformstringYes
StreetformstringYes
TownformstringYes
CountyformstringYes
LocalityformstringYes
PostcodeformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/address/{Postcode} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Addresses":[{"Property":"String","Street":"String","Town":"String","County":"String","Locality":"String","Postcode":"String"}]}