GET api/Address/GetRegions?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 Region

Name	Type	Additional information
RegionId	string	None.
RegionName	string	None.
NameWithoutDiacritics	string	None.
SmCountryRef	string	None.
UniqueId	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "RegionId": "sample string 1",
    "RegionName": "sample string 2",
    "NameWithoutDiacritics": "sample string 2",
    "SmCountryRef": "sample string 3",
    "UniqueId": "sample string 4"
  },
  {
    "RegionId": "sample string 1",
    "RegionName": "sample string 2",
    "NameWithoutDiacritics": "sample string 2",
    "SmCountryRef": "sample string 3",
    "UniqueId": "sample string 4"
  }
]

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

Sample:

/**/ typeof  === 'function' && ([{"RegionId":"sample string 1","RegionName":"sample string 2","NameWithoutDiacritics":"sample string 2","SmCountryRef":"sample string 3","UniqueId":"sample string 4"},{"RegionId":"sample string 1","RegionName":"sample string 2","NameWithoutDiacritics":"sample string 2","SmCountryRef":"sample string 3","UniqueId":"sample string 4"}]);

application/xml, text/xml

Sample:

<ArrayOfRegion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models.Regions">
  <Region>
    <RegionId>sample string 1</RegionId>
    <RegionName>sample string 2</RegionName>
    <SmCountryRef>sample string 3</SmCountryRef>
    <UniqueId>sample string 4</UniqueId>
  </Region>
  <Region>
    <RegionId>sample string 1</RegionId>
    <RegionName>sample string 2</RegionName>
    <SmCountryRef>sample string 3</SmCountryRef>
    <UniqueId>sample string 4</UniqueId>
  </Region>
</ArrayOfRegion>