POST Location/Places

Get Districts for a postal code and country

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CountryID	integer	None.
RegionID	integer	None.
ProvinceID	integer	None.
PostalCode	string	Required
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CountryID": 1,
  "RegionID": 1,
  "ProvinceID": 1,
  "PostalCode": "sample string 2",
  "Lang": "sample string 3",
  "StoreID": 4
}

application/xml, text/xml

Sample:

<GetPlaces xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 3</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">4</StoreID>
  <CountryID>1</CountryID>
  <PostalCode>sample string 2</PostalCode>
  <ProvinceID>1</ProvinceID>
  <RegionID>1</RegionID>
</GetPlaces>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Place

Name	Type	Additional information
ID	integer	None.
Name	string	None.
PostalCode	string	None.
LocalityID	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Name": "sample string 2",
    "PostalCode": "sample string 3",
    "LocalityID": 4
  },
  {
    "ID": 1,
    "Name": "sample string 2",
    "PostalCode": "sample string 3",
    "LocalityID": 4
  }
]

application/xml, text/xml

Sample:

<ArrayOfPlace xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location">
  <Place>
    <ID>1</ID>
    <LocalityID>4</LocalityID>
    <Name>sample string 2</Name>
    <PostalCode>sample string 3</PostalCode>
  </Place>
  <Place>
    <ID>1</ID>
    <LocalityID>4</LocalityID>
    <Name>sample string 2</Name>
    <PostalCode>sample string 3</PostalCode>
  </Place>
</ArrayOfPlace>