GET api/Address/GetCitiesWithoutZips?smCountryRef={smCountryRef}®ionName={regionName}&searchTerm={searchTerm}&maxResults={maxResults}&es={es}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
smCountryRef | string |
Required |
|
regionName | 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 CityName | Description | Type | Additional information |
---|---|---|---|
ZipId | string |
None. |
|
CityName | string |
None. |
|
CityNameWithoutDiacritics | string |
None. |
|
RegionName | string |
None. |
|
RegionId | string |
None. |
|
Zips | Collection of Zip |
None. |
|
IndexId | string |
None. |
|
CountyId | string |
None. |
|
SmCountryRef | string |
None. |
|
UniqueId | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ZipId": "sample string 1", "CityName": "sample string 2", "CityNameWithoutDiacritics": "sample string 3", "RegionName": "sample string 4", "RegionId": "sample string 5", "Zips": [ { "Id": "sample string 1", "Value": "sample string 2" }, { "Id": "sample string 1", "Value": "sample string 2" } ], "IndexId": "sample string 6", "CountyId": "sample string 7", "SmCountryRef": "sample string 8", "UniqueId": "sample string 9" }, { "ZipId": "sample string 1", "CityName": "sample string 2", "CityNameWithoutDiacritics": "sample string 3", "RegionName": "sample string 4", "RegionId": "sample string 5", "Zips": [ { "Id": "sample string 1", "Value": "sample string 2" }, { "Id": "sample string 1", "Value": "sample string 2" } ], "IndexId": "sample string 6", "CountyId": "sample string 7", "SmCountryRef": "sample string 8", "UniqueId": "sample string 9" } ]
text/javascript, application/javascript, application/json-p
Sample:
/**/ typeof === 'function' && ([{"ZipId":"sample string 1","CityName":"sample string 2","CityNameWithoutDiacritics":"sample string 3","RegionName":"sample string 4","RegionId":"sample string 5","Zips":[{"Id":"sample string 1","Value":"sample string 2"},{"Id":"sample string 1","Value":"sample string 2"}],"IndexId":"sample string 6","CountyId":"sample string 7","SmCountryRef":"sample string 8","UniqueId":"sample string 9"},{"ZipId":"sample string 1","CityName":"sample string 2","CityNameWithoutDiacritics":"sample string 3","RegionName":"sample string 4","RegionId":"sample string 5","Zips":[{"Id":"sample string 1","Value":"sample string 2"},{"Id":"sample string 1","Value":"sample string 2"}],"IndexId":"sample string 6","CountyId":"sample string 7","SmCountryRef":"sample string 8","UniqueId":"sample string 9"}]);
application/xml, text/xml
Sample:
<ArrayOfCity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models.Cities"> <City> <CityName>sample string 2</CityName> <CityNameWithoutDiacritics>sample string 3</CityNameWithoutDiacritics> <CountyId>sample string 7</CountyId> <IndexId>sample string 6</IndexId> <RegionId>sample string 5</RegionId> <RegionName>sample string 4</RegionName> <SmCountryRef>sample string 8</SmCountryRef> <UniqueId>sample string 9</UniqueId> <ZipId>sample string 1</ZipId> <Zips> <Zip> <Id>sample string 1</Id> <Value>sample string 2</Value> </Zip> <Zip> <Id>sample string 1</Id> <Value>sample string 2</Value> </Zip> </Zips> </City> <City> <CityName>sample string 2</CityName> <CityNameWithoutDiacritics>sample string 3</CityNameWithoutDiacritics> <CountyId>sample string 7</CountyId> <IndexId>sample string 6</IndexId> <RegionId>sample string 5</RegionId> <RegionName>sample string 4</RegionName> <SmCountryRef>sample string 8</SmCountryRef> <UniqueId>sample string 9</UniqueId> <ZipId>sample string 1</ZipId> <Zips> <Zip> <Id>sample string 1</Id> <Value>sample string 2</Value> </Zip> <Zip> <Id>sample string 1</Id> <Value>sample string 2</Value> </Zip> </Zips> </City> </ArrayOfCity>