GET common/postcodes/search?code={code}&name={name}&country={country}

Request Information

URI Parameters

Name	Type	Additional information
code	string	None.
name	string	None.
country	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Postcode

Name	Type	Additional information
ID	string	None.
CountryID	integer	None.
Country	Country	None.
Code	string	None.
City	string	None.
Audit	Audit	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": "2-sample string 3",
    "CountryID": 2,
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "CurrencyID": 1,
      "Currency": {
        "ID": 1,
        "Code": "sample string 2",
        "Name": "sample string 3",
        "Sign": "sample string 4",
        "Lookup": "sample string 5"
      },
      "ISO31661": 1,
      "Alpha2": "sample string 3",
      "Alpha3": "sample string 4",
      "Audit": {
        "AddUser": 1,
        "AddTime": "2025-04-03T07:09:13.8701435+00:00",
        "EditUser": 1,
        "EditTime": "2025-04-03T07:09:13.8701435+00:00"
      }
    },
    "Code": "sample string 3",
    "City": "sample string 4",
    "Audit": {
      "AddUser": 1,
      "AddTime": "2025-04-03T07:09:13.8701435+00:00",
      "EditUser": 1,
      "EditTime": "2025-04-03T07:09:13.8701435+00:00"
    }
  },
  {
    "ID": "2-sample string 3",
    "CountryID": 2,
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "CurrencyID": 1,
      "Currency": {
        "ID": 1,
        "Code": "sample string 2",
        "Name": "sample string 3",
        "Sign": "sample string 4",
        "Lookup": "sample string 5"
      },
      "ISO31661": 1,
      "Alpha2": "sample string 3",
      "Alpha3": "sample string 4",
      "Audit": {
        "AddUser": 1,
        "AddTime": "2025-04-03T07:09:13.8701435+00:00",
        "EditUser": 1,
        "EditTime": "2025-04-03T07:09:13.8701435+00:00"
      }
    },
    "Code": "sample string 3",
    "City": "sample string 4",
    "Audit": {
      "AddUser": 1,
      "AddTime": "2025-04-03T07:09:13.8701435+00:00",
      "EditUser": 1,
      "EditTime": "2025-04-03T07:09:13.8701435+00:00"
    }
  }
]

text/xml

Sample:

<ArrayOfPostcode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
  <Postcode>
    <Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2025-04-03T07:09:13.8701435+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2025-04-03T07:09:13.8701435+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </Audit>
    <City>sample string 4</City>
    <Code>sample string 3</Code>
    <Country>
      <Alpha2>sample string 3</Alpha2>
      <Alpha3>sample string 4</Alpha3>
      <Audit xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
        <d4p1:AddTime>2025-04-03T07:09:13.8701435+00:00</d4p1:AddTime>
        <d4p1:AddUser>1</d4p1:AddUser>
        <d4p1:EditTime>2025-04-03T07:09:13.8701435+00:00</d4p1:EditTime>
        <d4p1:EditUser>1</d4p1:EditUser>
      </Audit>
      <Currency>
        <Code>sample string 2</Code>
        <ID>1</ID>
        <Lookup>sample string 5</Lookup>
        <Name>sample string 3</Name>
        <Sign>sample string 4</Sign>
      </Currency>
      <CurrencyID>1</CurrencyID>
      <ID>1</ID>
      <ISO31661>1</ISO31661>
      <Name>sample string 2</Name>
    </Country>
    <CountryID>2</CountryID>
    <ID>2-sample string 3</ID>
  </Postcode>
  <Postcode>
    <Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2025-04-03T07:09:13.8701435+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2025-04-03T07:09:13.8701435+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </Audit>
    <City>sample string 4</City>
    <Code>sample string 3</Code>
    <Country>
      <Alpha2>sample string 3</Alpha2>
      <Alpha3>sample string 4</Alpha3>
      <Audit xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
        <d4p1:AddTime>2025-04-03T07:09:13.8701435+00:00</d4p1:AddTime>
        <d4p1:AddUser>1</d4p1:AddUser>
        <d4p1:EditTime>2025-04-03T07:09:13.8701435+00:00</d4p1:EditTime>
        <d4p1:EditUser>1</d4p1:EditUser>
      </Audit>
      <Currency>
        <Code>sample string 2</Code>
        <ID>1</ID>
        <Lookup>sample string 5</Lookup>
        <Name>sample string 3</Name>
        <Sign>sample string 4</Sign>
      </Currency>
      <CurrencyID>1</CurrencyID>
      <ID>1</ID>
      <ISO31661>1</ISO31661>
      <Name>sample string 2</Name>
    </Country>
    <CountryID>2</CountryID>
    <ID>2-sample string 3</ID>
  </Postcode>
</ArrayOfPostcode>