GET api/address?postcode={postcode}&id={id}

Searches for general address data based on a postal code.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
postcode

The postcode postcode.

string

Required

id

string

Required

Body Parameters

None.

Response Information

Resource Description

The results of the search, each consisting of general description of a corresponding address.

Collection of ERP.Domain.CustomerPortal.ServiceResult
NameDescriptionTypeAdditional information
Address

string

None.

Postcode

string

None.

Id

string

None.

Type

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "address": "sample string 1",
    "postcode": "sample string 2",
    "id": "sample string 3",
    "type": "sample string 4"
  },
  {
    "address": "sample string 1",
    "postcode": "sample string 2",
    "id": "sample string 3",
    "type": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfServiceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Domain.CustomerPortal">
  <ServiceResult>
    <Address>sample string 1</Address>
    <Id>sample string 3</Id>
    <Postcode>sample string 2</Postcode>
    <Type>sample string 4</Type>
  </ServiceResult>
  <ServiceResult>
    <Address>sample string 1</Address>
    <Id>sample string 3</Id>
    <Postcode>sample string 2</Postcode>
    <Type>sample string 4</Type>
  </ServiceResult>
</ArrayOfServiceResult>