GET api/Address/GetAddresses?smCountryRef={smCountryRef}&cityName={cityName}&searchTerm={searchTerm}&postcode={postcode}&maxResults={maxResults}&es={es}

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Collection of StreetFlat

Name	Type	Additional information
SmCountryRef	string	None.
CityName	string	None.
Zip	string	None.
ZipId	string	None.
StreetId	string	None.
SegmentId	string	None.
StreetName	string	None.
SegmentValue	string	None.
FullStreetName	string	None.
FullStreetNameWithoutDiacritics	string	None.
BuildingType	BuildingType	None.
CompCol_CityName_Upper	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SmCountryRef": "sample string 1",
    "CityName": "sample string 2",
    "Zip": "sample string 3",
    "ZipId": "sample string 4",
    "StreetId": "sample string 5",
    "SegmentId": "sample string 6",
    "StreetName": "sample string 7",
    "SegmentValue": "sample string 8",
    "FullStreetName": "sample string 9",
    "FullStreetNameWithoutDiacritics": "sample string 10",
    "BuildingType": 0,
    "CompCol_CityName_Upper": "sample string 11"
  },
  {
    "SmCountryRef": "sample string 1",
    "CityName": "sample string 2",
    "Zip": "sample string 3",
    "ZipId": "sample string 4",
    "StreetId": "sample string 5",
    "SegmentId": "sample string 6",
    "StreetName": "sample string 7",
    "SegmentValue": "sample string 8",
    "FullStreetName": "sample string 9",
    "FullStreetNameWithoutDiacritics": "sample string 10",
    "BuildingType": 0,
    "CompCol_CityName_Upper": "sample string 11"
  }
]

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

Sample:

/**/ typeof  === 'function' && ([{"SmCountryRef":"sample string 1","CityName":"sample string 2","Zip":"sample string 3","ZipId":"sample string 4","StreetId":"sample string 5","SegmentId":"sample string 6","StreetName":"sample string 7","SegmentValue":"sample string 8","FullStreetName":"sample string 9","FullStreetNameWithoutDiacritics":"sample string 10","BuildingType":0,"CompCol_CityName_Upper":"sample string 11"},{"SmCountryRef":"sample string 1","CityName":"sample string 2","Zip":"sample string 3","ZipId":"sample string 4","StreetId":"sample string 5","SegmentId":"sample string 6","StreetName":"sample string 7","SegmentValue":"sample string 8","FullStreetName":"sample string 9","FullStreetNameWithoutDiacritics":"sample string 10","BuildingType":0,"CompCol_CityName_Upper":"sample string 11"}]);

application/xml, text/xml

Sample:

<ArrayOfStreetFlat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models.Streets">
  <StreetFlat>
    <BuildingType>House</BuildingType>
    <CityName>sample string 2</CityName>
    <CompCol_CityName_Upper>sample string 11</CompCol_CityName_Upper>
    <FullStreetName>sample string 9</FullStreetName>
    <FullStreetNameWithoutDiacritics>sample string 10</FullStreetNameWithoutDiacritics>
    <SegmentId>sample string 6</SegmentId>
    <SegmentValue>sample string 8</SegmentValue>
    <SmCountryRef>sample string 1</SmCountryRef>
    <StreetId>sample string 5</StreetId>
    <StreetName>sample string 7</StreetName>
    <Zip>sample string 3</Zip>
    <ZipId>sample string 4</ZipId>
  </StreetFlat>
  <StreetFlat>
    <BuildingType>House</BuildingType>
    <CityName>sample string 2</CityName>
    <CompCol_CityName_Upper>sample string 11</CompCol_CityName_Upper>
    <FullStreetName>sample string 9</FullStreetName>
    <FullStreetNameWithoutDiacritics>sample string 10</FullStreetNameWithoutDiacritics>
    <SegmentId>sample string 6</SegmentId>
    <SegmentValue>sample string 8</SegmentValue>
    <SmCountryRef>sample string 1</SmCountryRef>
    <StreetId>sample string 5</StreetId>
    <StreetName>sample string 7</StreetName>
    <Zip>sample string 3</Zip>
    <ZipId>sample string 4</ZipId>
  </StreetFlat>
</ArrayOfStreetFlat>