GET | /v1/address/{Postcode} | Get Address by PostCode | Get Address by PostCode |
---|---|---|---|
GET | /v1/address/{Postcode}/{HouseNameOrNumber} | Get Address by PostCode and Premise | Get Address by PostCode and Premise |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Postcode | path | string | Yes | |
HouseNameOrNumber | path | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Addresses | form | List<Address> | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Property | form | string | Yes | |
Street | form | string | Yes | |
Town | form | string | Yes | |
County | form | string | Yes | |
Locality | form | string | Yes | |
Postcode | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Addresses: [ { Property: String, Street: String, Town: String, County: String, Locality: String, Postcode: String } ] }