POST api/APIAddress/GetAddress
Request Information
URI Parameters
None.
Body Parameters
APIAddressRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PostCode | string |
None. |
|
| HouseNo | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"PostCode": "sample string 1",
"HouseNo": 2
}
application/xml, text/xml
Sample:
<APIAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Request"> <HouseNo>2</HouseNo> <PostCode>sample string 1</PostCode> </APIAddressRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetAllAddressDetailResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressDetails | Collection of AddressDetailModel |
None. |
|
| ResponseCode | integer |
None. |
|
| ResponseText | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"AddressDetails": [
{
"ID": 1,
"City": "sample string 1",
"ZipCode": "sample string 2",
"HouseNumber": 3,
"Province": "sample string 4",
"ProvinceShortCode": "sample string 5",
"StreetName": "sample string 6"
},
{
"ID": 1,
"City": "sample string 1",
"ZipCode": "sample string 2",
"HouseNumber": 3,
"Province": "sample string 4",
"ProvinceShortCode": "sample string 5",
"StreetName": "sample string 6"
}
],
"ResponseCode": 1,
"ResponseText": "sample string 2"
}
application/xml, text/xml
Sample:
<GetAllAddressDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Response">
<ResponseCode xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">1</ResponseCode>
<ResponseText xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">sample string 2</ResponseText>
<AddressDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
<d2p1:AddressDetailModel>
<d2p1:City>sample string 1</d2p1:City>
<d2p1:HouseNumber>3</d2p1:HouseNumber>
<d2p1:ID>1</d2p1:ID>
<d2p1:Province>sample string 4</d2p1:Province>
<d2p1:ProvinceShortCode>sample string 5</d2p1:ProvinceShortCode>
<d2p1:StreetName>sample string 6</d2p1:StreetName>
<d2p1:ZipCode>sample string 2</d2p1:ZipCode>
</d2p1:AddressDetailModel>
<d2p1:AddressDetailModel>
<d2p1:City>sample string 1</d2p1:City>
<d2p1:HouseNumber>3</d2p1:HouseNumber>
<d2p1:ID>1</d2p1:ID>
<d2p1:Province>sample string 4</d2p1:Province>
<d2p1:ProvinceShortCode>sample string 5</d2p1:ProvinceShortCode>
<d2p1:StreetName>sample string 6</d2p1:StreetName>
<d2p1:ZipCode>sample string 2</d2p1:ZipCode>
</d2p1:AddressDetailModel>
</AddressDetails>
</GetAllAddressDetailResponse>