| GET | /v1/address/{Postcode} | Get Address by PostCode | |
|---|---|---|---|
| GET | /v1/address/{Postcode}/{HouseNameOrNumber} | Get Address by PostCode and Premise |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
property: Optional[str] = None
street: Optional[str] = None
town: Optional[str] = None
county: Optional[str] = None
locality: Optional[str] = None
postcode: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAddressResponse:
addresses: List[Address] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAddressRequest(IGet):
postcode: Optional[str] = None
house_name_or_number: Optional[str] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Addresses":[{"Property":"String","Street":"String","Town":"String","County":"String","Locality":"String","Postcode":"String"}]}