GET api/Address/GetZips?smCountryRef={smCountryRef}&searchTerm={searchTerm}&maxResults={maxResults}&es={es}

Request Information

URI Parameters

Name	Type	Additional information
smCountryRef	string	Required
searchTerm	string	Required
maxResults	integer	Default value is 10
es	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of ZipFlat

Name	Type	Additional information
ZipId	string	None.
Zip	string	None.
CityName	string	None.
CityNameWithoutDiacritics	string	None.
CountyId	string	None.
RegionName	string	None.
RegionId	string	None.
IndexId	string	None.
SmCountryRef	string	None.
UniqueId	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ZipId": "sample string 1",
    "Zip": "sample string 2",
    "CityName": "sample string 3",
    "CityNameWithoutDiacritics": "sample string 4",
    "CountyId": "sample string 5",
    "RegionName": "sample string 6",
    "RegionId": "sample string 7",
    "IndexId": "sample string 8",
    "SmCountryRef": "sample string 9",
    "UniqueId": "sample string 10"
  },
  {
    "ZipId": "sample string 1",
    "Zip": "sample string 2",
    "CityName": "sample string 3",
    "CityNameWithoutDiacritics": "sample string 4",
    "CountyId": "sample string 5",
    "RegionName": "sample string 6",
    "RegionId": "sample string 7",
    "IndexId": "sample string 8",
    "SmCountryRef": "sample string 9",
    "UniqueId": "sample string 10"
  }
]

text/javascript, application/javascript, application/json-p

Sample:

/**/ typeof  === 'function' && ([{"ZipId":"sample string 1","Zip":"sample string 2","CityName":"sample string 3","CityNameWithoutDiacritics":"sample string 4","CountyId":"sample string 5","RegionName":"sample string 6","RegionId":"sample string 7","IndexId":"sample string 8","SmCountryRef":"sample string 9","UniqueId":"sample string 10"},{"ZipId":"sample string 1","Zip":"sample string 2","CityName":"sample string 3","CityNameWithoutDiacritics":"sample string 4","CountyId":"sample string 5","RegionName":"sample string 6","RegionId":"sample string 7","IndexId":"sample string 8","SmCountryRef":"sample string 9","UniqueId":"sample string 10"}]);

application/xml, text/xml

Sample:

<ArrayOfZipFlat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models.Cities">
  <ZipFlat>
    <CityName>sample string 3</CityName>
    <CityNameWithoutDiacritics>sample string 4</CityNameWithoutDiacritics>
    <CountyId>sample string 5</CountyId>
    <IndexId>sample string 8</IndexId>
    <RegionId>sample string 7</RegionId>
    <RegionName>sample string 6</RegionName>
    <SmCountryRef>sample string 9</SmCountryRef>
    <UniqueId>sample string 10</UniqueId>
    <Zip>sample string 2</Zip>
    <ZipId>sample string 1</ZipId>
  </ZipFlat>
  <ZipFlat>
    <CityName>sample string 3</CityName>
    <CityNameWithoutDiacritics>sample string 4</CityNameWithoutDiacritics>
    <CountyId>sample string 5</CountyId>
    <IndexId>sample string 8</IndexId>
    <RegionId>sample string 7</RegionId>
    <RegionName>sample string 6</RegionName>
    <SmCountryRef>sample string 9</SmCountryRef>
    <UniqueId>sample string 10</UniqueId>
    <Zip>sample string 2</Zip>
    <ZipId>sample string 1</ZipId>
  </ZipFlat>
</ArrayOfZipFlat>