GET api/v1/searches/{keyword}/locations?maxNumber={maxNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
keyword

string

Required

maxNumber

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of GroupedLookup
NameDescriptionTypeAdditional information
Id

integer

None.

Value

string

None.

Extra

Dictionary of string [key] and Object [value]

None.

GroupName

string

None.

Response Formats

application/json, text/json, text/html

Sample:
[
  {
    "id": 1,
    "value": "sample string 2",
    "extra": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "groupName": "sample string 3"
  },
  {
    "id": 1,
    "value": "sample string 2",
    "extra": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "groupName": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfGroupedLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VOL.Core.CustomModels">
  <GroupedLookup>
    <Extra xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Extra>
    <GroupName>sample string 3</GroupName>
    <Id>1</Id>
    <Value>sample string 2</Value>
  </GroupedLookup>
  <GroupedLookup>
    <Extra xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Extra>
    <GroupName>sample string 3</GroupName>
    <Id>1</Id>
    <Value>sample string 2</Value>
  </GroupedLookup>
</ArrayOfGroupedLookup>