GET, POST | /Address |
---|
// @DataContract(Name="Capture_Interactive_Retrieve_v1_00_Results", Namespace="http://services.postcodeanywhere.co.uk/")
export class Capture_Interactive_Retrieve_v1_00_Results
{
// @DataMember(EmitDefaultValue=false)
public Id?: string;
// @DataMember(Order=1, EmitDefaultValue=false)
public DomesticId?: string;
// @DataMember(Order=2, EmitDefaultValue=false)
public Language?: string;
// @DataMember(Order=3, EmitDefaultValue=false)
public LanguageAlternatives?: string;
// @DataMember(Order=4, EmitDefaultValue=false)
public Department?: string;
// @DataMember(Order=5, EmitDefaultValue=false)
public Company?: string;
// @DataMember(Order=6, EmitDefaultValue=false)
public SubBuilding?: string;
// @DataMember(Order=7, EmitDefaultValue=false)
public BuildingNumber?: string;
// @DataMember(Order=8, EmitDefaultValue=false)
public BuildingName?: string;
// @DataMember(Order=9, EmitDefaultValue=false)
public SecondaryStreet?: string;
// @DataMember(Order=10, EmitDefaultValue=false)
public Street?: string;
// @DataMember(Order=11, EmitDefaultValue=false)
public Block?: string;
// @DataMember(Order=12, EmitDefaultValue=false)
public Neighbourhood?: string;
// @DataMember(Order=13, EmitDefaultValue=false)
public District?: string;
// @DataMember(Order=14, EmitDefaultValue=false)
public City?: string;
// @DataMember(Order=15, EmitDefaultValue=false)
public Line1?: string;
// @DataMember(Order=16, EmitDefaultValue=false)
public Line2?: string;
// @DataMember(Order=17, EmitDefaultValue=false)
public Line3?: string;
// @DataMember(Order=18, EmitDefaultValue=false)
public Line4?: string;
// @DataMember(Order=19, EmitDefaultValue=false)
public Line5?: string;
// @DataMember(Order=20, EmitDefaultValue=false)
public AdminAreaName?: string;
// @DataMember(Order=21, EmitDefaultValue=false)
public AdminAreaCode?: string;
// @DataMember(Order=22, EmitDefaultValue=false)
public Province?: string;
// @DataMember(Order=23, EmitDefaultValue=false)
public ProvinceName?: string;
// @DataMember(Order=24, EmitDefaultValue=false)
public ProvinceCode?: string;
// @DataMember(Order=25, EmitDefaultValue=false)
public PostalCode?: string;
// @DataMember(Order=26, EmitDefaultValue=false)
public CountryName?: string;
// @DataMember(Order=27, EmitDefaultValue=false)
public CountryIso2?: string;
// @DataMember(Order=28, EmitDefaultValue=false)
public CountryIso3?: string;
// @DataMember(Order=29, IsRequired=true)
public CountryIsoNumber?: number;
// @DataMember(Order=30, EmitDefaultValue=false)
public SortingNumber1?: string;
// @DataMember(Order=31, EmitDefaultValue=false)
public SortingNumber2?: string;
// @DataMember(Order=32, EmitDefaultValue=false)
public Barcode?: string;
// @DataMember(Order=33, EmitDefaultValue=false)
public POBoxNumber?: string;
// @DataMember(Order=34, EmitDefaultValue=false)
public Label?: string;
// @DataMember(Order=35, EmitDefaultValue=false)
public Type?: string;
// @DataMember(Order=36, EmitDefaultValue=false)
public DataLevel?: string;
// @DataMember(Order=37, EmitDefaultValue=false)
public Field1?: string;
// @DataMember(Order=38, EmitDefaultValue=false)
public Field2?: string;
// @DataMember(Order=39, EmitDefaultValue=false)
public Field3?: string;
// @DataMember(Order=40, EmitDefaultValue=false)
public Field4?: string;
// @DataMember(Order=41, EmitDefaultValue=false)
public Field5?: string;
// @DataMember(Order=42, EmitDefaultValue=false)
public Field6?: string;
// @DataMember(Order=43, EmitDefaultValue=false)
public Field7?: string;
// @DataMember(Order=44, EmitDefaultValue=false)
public Field8?: string;
// @DataMember(Order=45, EmitDefaultValue=false)
public Field9?: string;
// @DataMember(Order=46, EmitDefaultValue=false)
public Field10?: string;
// @DataMember(Order=47, EmitDefaultValue=false)
public Field11?: string;
// @DataMember(Order=48, EmitDefaultValue=false)
public Field12?: string;
// @DataMember(Order=49, EmitDefaultValue=false)
public Field13?: string;
// @DataMember(Order=50, EmitDefaultValue=false)
public Field14?: string;
// @DataMember(Order=51, EmitDefaultValue=false)
public Field15?: string;
// @DataMember(Order=52, EmitDefaultValue=false)
public Field16?: string;
// @DataMember(Order=53, EmitDefaultValue=false)
public Field17?: string;
// @DataMember(Order=54, EmitDefaultValue=false)
public Field18?: string;
// @DataMember(Order=55, EmitDefaultValue=false)
public Field19?: string;
// @DataMember(Order=56, EmitDefaultValue=false)
public Field20?: string;
public constructor(init?: Partial<Capture_Interactive_Retrieve_v1_00_Results>) { (Object as any).assign(this, init); }
}
// @DataContract(Name="Capture_Interactive_Find_v1_00_Results", Namespace="http://services.postcodeanywhere.co.uk/")
export class Capture_Interactive_Find_v1_00_Results
{
// @DataMember(EmitDefaultValue=false)
public Id?: string;
// @DataMember(EmitDefaultValue=false)
public Type?: string;
// @DataMember(Order=2, EmitDefaultValue=false)
public Text?: string;
// @DataMember(Order=3, EmitDefaultValue=false)
public Highlight?: string;
// @DataMember(Order=4, EmitDefaultValue=false)
public Description?: string;
public constructor(init?: Partial<Capture_Interactive_Find_v1_00_Results>) { (Object as any).assign(this, init); }
}
export class AdderessResponse
{
/**
* Contains response status, details and errors.
*/
public Successful?: boolean;
/**
* The Csr of the application (if available).
*/
public Csr?: string;
/**
* Contains the Adderess lookup Retrieve result when successful.
*/
public RetrieveResult?: Capture_Interactive_Retrieve_v1_00_Results[];
/**
* Contains the Adderess lookup Find result when successful.
*/
public FindResults?: Capture_Interactive_Find_v1_00_Results[];
public constructor(init?: Partial<AdderessResponse>) { (Object as any).assign(this, init); }
}
export class AddressRequest
{
/**
* The Text is address code.
*/
// @Required()
public Text?: string;
/**
* The Container is address Id.
*/
// @Required()
public Container?: string;
/**
* The Type is type of addresss.
*/
// @Required()
public Type?: string;
/**
* The Csr of the application (if available).
*/
public CSR?: string;
/**
* The SourceCode of the Adderess.
*/
public SourceCode?: string;
public constructor(init?: Partial<AddressRequest>) { (Object as any).assign(this, init); }
}
TypeScript AddressRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Address HTTP/1.1
Host: wp-cddws-test.worldpay.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Text":"String","Container":"String","Type":"String","CSR":"String","SourceCode":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Successful":false,"Csr":"String"}