| 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 |
import Foundation
import ServiceStack
public class GetAddressRequest : IGet, Codable
{
public var postcode:String
public var houseNameOrNumber:String
required public init(){}
}
public class GetAddressResponse : Codable
{
public var addresses:[Address] = []
required public init(){}
}
public class Address : Codable
{
public var property:String
public var street:String
public var town:String
public var county:String
public var locality:String
public var postcode:String
required public init(){}
}
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
}
]
}