This action may lead to changes in the database
Do you want to continue?
Data Explorer
Web API Query String
Request Information
Get Typeahead Locations for the Partner using a Search term and optionally Location Types to filter
Parameters:
- PartnerId
- SearchTerm
- Types
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
partnerId |
Partner Id |
integer |
Required |
searchTerm |
Search Term |
string |
None. |
types |
Optional comma separated Location Types (Market,City,County,Zip,Community) |
string |
None. |
includeAll |
Include all markets |
boolean |
Default value is False |
Response
×
The request was made Successfully! Check the result!.
×
Error Something happen, the Api doesn't have a response.
[
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"MarketId": 4,
"MarketName": "sample string 5",
"MarketStateAbbr": "sample string 6",
"MarketStateName": "sample string 7",
"Latitude": 1.0,
"Longitude": 1.0,
"City": "sample string 8",
"State": "sample string 9",
"HasShowCase": true,
"BrandType": "sample string 10"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"MarketId": 4,
"MarketName": "sample string 5",
"MarketStateAbbr": "sample string 6",
"MarketStateName": "sample string 7",
"Latitude": 1.0,
"Longitude": 1.0,
"City": "sample string 8",
"State": "sample string 9",
"HasShowCase": true,
"BrandType": "sample string 10"
}
]
Sample not available.
Sample not available.
Code Generator
Response Information
List of ApiTypeaheadLocation
Name | Description | Type | Additional information |
---|---|---|---|
Id |
Id |
integer |
None. |
Name |
Name |
string |
None. |
Type |
Type |
string |
None. |
MarketId |
MarketId |
integer |
None. |
MarketName |
MarketName |
string |
None. |
MarketStateAbbr | string |
None. |
|
MarketStateName | string |
None. |
|
Latitude |
Latitude |
decimal number |
None. |
Longitude |
Longitude |
decimal number |
None. |
City |
City |
string |
None. |
State |
State |
string |
None. |
HasShowCase | boolean |
None. |
|
BrandType | string |
None. |
GET
api/v2/Typeahead/Locations?partnerId={partnerId}&searchTerm={searchTerm}&types={types}&includeAll={includeAll}