| GET | /v1/address/{Postcode} | Get Address by PostCode | |
|---|---|---|---|
| GET | /v1/address/{Postcode}/{HouseNameOrNumber} | Get Address by PostCode and Premise |
export class Address
{
public Property: string;
public Street: string;
public Town: string;
public County: string;
public Locality: string;
public Postcode: string;
public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}
export class GetAddressResponse
{
public Addresses: Address[] = [];
public constructor(init?: Partial<GetAddressResponse>) { (Object as any).assign(this, init); }
}
export class GetAddressRequest implements IGet
{
public Postcode: string;
public HouseNameOrNumber: string;
public constructor(init?: Partial<GetAddressRequest>) { (Object as any).assign(this, init); }
}
TypeScript 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
}
]
}