POST api/City/GetAllByPostalCode

Request Information

URI Parameters

None.

Body Parameters

GetCitiesByPostalCodeRequest
NameDescriptionTypeAdditional information
PostalCode

string

Required

Request Formats

application/json, text/json

Sample:
{
  "PostalCode": "sample string 1"
}

application/xml, text/xml

Sample:
<GetCitiesByPostalCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Request">
  <PostalCode>sample string 1</PostalCode>
</GetCitiesByPostalCodeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetAllCityResponse
NameDescriptionTypeAdditional information
AllCityList

Collection of CityModel

None.

ResponseCode

integer

None.

ResponseText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AllCityList": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "StateID": 1,
      "CountryID": 1,
      "IsActive": true,
      "PostalCode": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "UpdatePermission": "sample string 6"
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "StateID": 1,
      "CountryID": 1,
      "IsActive": true,
      "PostalCode": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "UpdatePermission": "sample string 6"
    }
  ],
  "ResponseCode": 1,
  "ResponseText": "sample string 2"
}

application/xml, text/xml

Sample:
<GetAllCityResponse 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>
  <AllCityList xmlns:d2p1="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
    <d2p1:CityModel>
      <d2p1:Country>sample string 4</d2p1:Country>
      <d2p1:CountryID>1</d2p1:CountryID>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:PostalCode>sample string 3</d2p1:PostalCode>
      <d2p1:State>sample string 5</d2p1:State>
      <d2p1:StateID>1</d2p1:StateID>
      <d2p1:UpdatePermission>sample string 6</d2p1:UpdatePermission>
    </d2p1:CityModel>
    <d2p1:CityModel>
      <d2p1:Country>sample string 4</d2p1:Country>
      <d2p1:CountryID>1</d2p1:CountryID>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:PostalCode>sample string 3</d2p1:PostalCode>
      <d2p1:State>sample string 5</d2p1:State>
      <d2p1:StateID>1</d2p1:StateID>
      <d2p1:UpdatePermission>sample string 6</d2p1:UpdatePermission>
    </d2p1:CityModel>
  </AllCityList>
</GetAllCityResponse>