| GET | /v1/address/{Postcode} | Get Address by PostCode | |
|---|---|---|---|
| GET | /v1/address/{Postcode}/{HouseNameOrNumber} | Get Address by PostCode and Premise |
"use strict";
export class Address {
/** @param {{Property?:string,Street?:string,Town?:string,County?:string,Locality?:string,Postcode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Property;
/** @type {string} */
Street;
/** @type {string} */
Town;
/** @type {string} */
County;
/** @type {string} */
Locality;
/** @type {string} */
Postcode;
}
export class GetAddressResponse {
/** @param {{Addresses?:Address[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Address[]} */
Addresses = [];
}
export class GetAddressRequest {
/** @param {{Postcode?:string,HouseNameOrNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Postcode;
/** @type {string} */
HouseNameOrNumber;
}
JavaScript GetAddressRequest DTOs
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
}
]
}