GET | /2.0/address/{Postcode} | ||
---|---|---|---|
GET | /2.0/address/{Postcode}/{HouseNo} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Version | query | int | No | |
Postcode | path | string | Yes | Using a Postcode to return addresses. |
HouseNo | path | string | No | Optional input value to limit the return data to a specific address. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Addresses | form | Address[] | No | |
errormsg | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
County | form | string | No | |
Id | form | int | No | |
Locality | form | string | No | |
Organisation | form | string | No | |
Postcode | form | string | No | |
Property | form | string | No | |
RAPPPremiseId | form | int | No | |
Street | form | string | No | |
Town | form | string | No | |
FullAddress | form | string | No |
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 /2.0/address/{Postcode} HTTP/1.1 Host: webservices.mbukdatabase.co.uk Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Addresses: [ { County: String, Id: 0, Locality: String, Organisation: String, Postcode: String, Property: String, RAPPPremiseId: 0, Street: String, Town: String, FullAddress: "String, String, String, String, String, String" } ], errormsg: String }