GET common/countries/{country}/postcodes?skip={skip}&take={take}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
country

integer

Required

skip

integer

Default value is 0

take

integer

Default value is 50

Body Parameters

None.

Response Information

Resource Description

PagedDataOfPostcode
NameDescriptionTypeAdditional information
Data

Collection of Postcode

None.

Count

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "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": "2024-04-23T12:27:47.4149693+00:00",
          "EditUser": 1,
          "EditTime": "2024-04-23T12:27:47.4149693+00:00"
        }
      },
      "Code": "sample string 3",
      "City": "sample string 4",
      "Audit": {
        "AddUser": 1,
        "AddTime": "2024-04-23T12:27:47.4149693+00:00",
        "EditUser": 1,
        "EditTime": "2024-04-23T12:27:47.4149693+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": "2024-04-23T12:27:47.4149693+00:00",
          "EditUser": 1,
          "EditTime": "2024-04-23T12:27:47.4149693+00:00"
        }
      },
      "Code": "sample string 3",
      "City": "sample string 4",
      "Audit": {
        "AddUser": 1,
        "AddTime": "2024-04-23T12:27:47.4149693+00:00",
        "EditUser": 1,
        "EditTime": "2024-04-23T12:27:47.4149693+00:00"
      }
    }
  ],
  "Count": 1
}

text/xml

Sample:
<PagedDataOfPostcodeu0eXouiG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
  <Count>1</Count>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
    <d2p1:Postcode>
      <d2p1:Audit>
        <AddTime>2024-04-23T12:27:47.4149693+00:00</AddTime>
        <AddUser>1</AddUser>
        <EditTime>2024-04-23T12:27:47.4149693+00:00</EditTime>
        <EditUser>1</EditUser>
      </d2p1:Audit>
      <d2p1:City>sample string 4</d2p1:City>
      <d2p1:Code>sample string 3</d2p1:Code>
      <d2p1:Country>
        <d2p1:Alpha2>sample string 3</d2p1:Alpha2>
        <d2p1:Alpha3>sample string 4</d2p1:Alpha3>
        <d2p1:Audit>
          <AddTime>2024-04-23T12:27:47.4149693+00:00</AddTime>
          <AddUser>1</AddUser>
          <EditTime>2024-04-23T12:27:47.4149693+00:00</EditTime>
          <EditUser>1</EditUser>
        </d2p1:Audit>
        <d2p1:Currency>
          <d2p1:Code>sample string 2</d2p1:Code>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:Lookup>sample string 5</d2p1:Lookup>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:Sign>sample string 4</d2p1:Sign>
        </d2p1:Currency>
        <d2p1:CurrencyID>1</d2p1:CurrencyID>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:ISO31661>1</d2p1:ISO31661>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:Country>
      <d2p1:CountryID>2</d2p1:CountryID>
      <d2p1:ID>2-sample string 3</d2p1:ID>
    </d2p1:Postcode>
    <d2p1:Postcode>
      <d2p1:Audit>
        <AddTime>2024-04-23T12:27:47.4149693+00:00</AddTime>
        <AddUser>1</AddUser>
        <EditTime>2024-04-23T12:27:47.4149693+00:00</EditTime>
        <EditUser>1</EditUser>
      </d2p1:Audit>
      <d2p1:City>sample string 4</d2p1:City>
      <d2p1:Code>sample string 3</d2p1:Code>
      <d2p1:Country>
        <d2p1:Alpha2>sample string 3</d2p1:Alpha2>
        <d2p1:Alpha3>sample string 4</d2p1:Alpha3>
        <d2p1:Audit>
          <AddTime>2024-04-23T12:27:47.4149693+00:00</AddTime>
          <AddUser>1</AddUser>
          <EditTime>2024-04-23T12:27:47.4149693+00:00</EditTime>
          <EditUser>1</EditUser>
        </d2p1:Audit>
        <d2p1:Currency>
          <d2p1:Code>sample string 2</d2p1:Code>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:Lookup>sample string 5</d2p1:Lookup>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:Sign>sample string 4</d2p1:Sign>
        </d2p1:Currency>
        <d2p1:CurrencyID>1</d2p1:CurrencyID>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:ISO31661>1</d2p1:ISO31661>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:Country>
      <d2p1:CountryID>2</d2p1:CountryID>
      <d2p1:ID>2-sample string 3</d2p1:ID>
    </d2p1:Postcode>
  </Data>
</PagedDataOfPostcodeu0eXouiG>