PUT api/Content/v3/GetLocations
Request Information
URI Parameters
None.
Body Parameters
APILocationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Latitude | decimal number |
None. |
|
| Longitude | decimal number |
None. |
|
| Miles | integer |
None. |
|
| Meter | integer |
None. |
|
| SortBy | string |
None. |
|
| SortDir | string |
None. |
|
| PageNumber | integer |
None. |
|
| ProductId | integer |
None. |
|
| CustomerId | integer |
None. |
|
| UniqueId | globally unique identifier |
None. |
|
| UserUniqueId | integer |
None. |
|
| MemberId | integer |
None. |
|
| SearchText | string |
None. |
|
| IsMapView | boolean |
None. |
|
| CategoryId | integer |
None. |
|
| OnlyMainLocation | boolean |
None. |
|
| EventId | integer |
None. |
|
| RegionId | integer |
None. |
|
| FestivalId | integer |
None. |
|
| OnlyAssociation | boolean |
None. |
|
| ProgramId | integer |
None. |
|
| SectionId | integer |
None. |
|
| TagId | integer |
None. |
|
| LanguageCode | string |
None. |
|
| PageSize | integer |
None. |
|
| GroupCategoryIds | string |
None. |
|
| GroupSubCategoryIds | string |
None. |
|
| CategoryType | GroupCategoryEnum |
None. |
|
| CheckwithDefault | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Latitude": 1.0,
"Longitude": 1.0,
"Miles": 1,
"Meter": 2,
"SortBy": "sample string 3",
"SortDir": "sample string 4",
"PageNumber": 5,
"ProductId": 6,
"CustomerId": 7,
"UniqueId": "53afc311-48d5-4f1c-91be-4178893f4cef",
"UserUniqueId": 9,
"MemberId": 10,
"SearchText": "sample string 11",
"IsMapView": true,
"CategoryId": 13,
"OnlyMainLocation": true,
"EventId": 14,
"RegionId": 15,
"FestivalId": 16,
"OnlyAssociation": true,
"ProgramId": 18,
"SectionId": 19,
"TagId": 20,
"LanguageCode": "sample string 21",
"PageSize": 22,
"GroupCategoryIds": "sample string 23",
"GroupSubCategoryIds": "sample string 24",
"CategoryType": 1,
"CheckwithDefault": true
}
application/xml, text/xml
Sample:
<APILocationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model"> <CategoryId>13</CategoryId> <CategoryType>Category</CategoryType> <CheckwithDefault>true</CheckwithDefault> <CustomerId>7</CustomerId> <EventId>14</EventId> <FestivalId>16</FestivalId> <GroupCategoryIds>sample string 23</GroupCategoryIds> <GroupSubCategoryIds>sample string 24</GroupSubCategoryIds> <IsMapView>true</IsMapView> <LanguageCode>sample string 21</LanguageCode> <Latitude>1</Latitude> <Longitude>1</Longitude> <MemberId>10</MemberId> <Meter>2</Meter> <Miles>1</Miles> <OnlyAssociation>true</OnlyAssociation> <OnlyMainLocation>true</OnlyMainLocation> <PageNumber>5</PageNumber> <PageSize>22</PageSize> <ProductId>6</ProductId> <ProgramId>18</ProgramId> <RegionId>15</RegionId> <SearchText>sample string 11</SearchText> <SectionId>19</SectionId> <SortBy>sample string 3</SortBy> <SortDir>sample string 4</SortDir> <TagId>20</TagId> <UniqueId>53afc311-48d5-4f1c-91be-4178893f4cef</UniqueId> <UserUniqueId>9</UserUniqueId> </APILocationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
APILocationResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| List | Collection of APILocationV2 |
None. |
|
| TotalRecords | integer |
None. |
|
| BeerChipMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"List": [
{
"Id": 1,
"Latitude": 1.0,
"Longitude": 1.0,
"Address": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Country": "sample string 5",
"ZipCode": "sample string 6",
"Phone": "sample string 7",
"Title": "sample string 8",
"DistanceInMeter": 1.0,
"DistanceInMile": 1.0,
"Distance": {
"DistanceInMeter": 1.0,
"DistanceInMile": 2.0
},
"MemberId": 1,
"CustomerName": "sample string 9",
"Thumb": "sample string 10",
"AvgRating": 11.0,
"IsFeatrureList": true,
"AdvertiseId": 13,
"IsAlreadyInFav": true,
"IsAlreadyInWishList": true,
"IsVerified": true,
"BrewerId": 17,
"BeerCount": 18,
"ProductCount": 19,
"BoothNumber": "sample string 20",
"TitleComputed": "sample string 21",
"WebSite": "sample string 22",
"IsBeerChip": true,
"IsSponsor": true,
"IsVisited": true,
"Category": "sample string 26",
"IsMember": true,
"Tags": [
{
"Id": 1,
"Title": "sample string 2",
"LocationId": 3
},
{
"Id": 1,
"Title": "sample string 2",
"LocationId": 3
}
],
"IsProductionOnly": true,
"Image": "sample string 27",
"Features": [
{
"Name": "sample string 1",
"LocationId": 2
},
{
"Name": "sample string 1",
"LocationId": 2
}
]
},
{
"Id": 1,
"Latitude": 1.0,
"Longitude": 1.0,
"Address": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Country": "sample string 5",
"ZipCode": "sample string 6",
"Phone": "sample string 7",
"Title": "sample string 8",
"DistanceInMeter": 1.0,
"DistanceInMile": 1.0,
"Distance": {
"DistanceInMeter": 1.0,
"DistanceInMile": 2.0
},
"MemberId": 1,
"CustomerName": "sample string 9",
"Thumb": "sample string 10",
"AvgRating": 11.0,
"IsFeatrureList": true,
"AdvertiseId": 13,
"IsAlreadyInFav": true,
"IsAlreadyInWishList": true,
"IsVerified": true,
"BrewerId": 17,
"BeerCount": 18,
"ProductCount": 19,
"BoothNumber": "sample string 20",
"TitleComputed": "sample string 21",
"WebSite": "sample string 22",
"IsBeerChip": true,
"IsSponsor": true,
"IsVisited": true,
"Category": "sample string 26",
"IsMember": true,
"Tags": [
{
"Id": 1,
"Title": "sample string 2",
"LocationId": 3
},
{
"Id": 1,
"Title": "sample string 2",
"LocationId": 3
}
],
"IsProductionOnly": true,
"Image": "sample string 27",
"Features": [
{
"Name": "sample string 1",
"LocationId": 2
},
{
"Name": "sample string 1",
"LocationId": 2
}
]
}
],
"TotalRecords": 1,
"BeerChipMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<APILocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
<BeerChipMessage>sample string 2</BeerChipMessage>
<List>
<APILocationV2>
<Address>sample string 2</Address>
<AdvertiseId>13</AdvertiseId>
<AvgRating>11</AvgRating>
<BeerCount>18</BeerCount>
<BoothNumber>sample string 20</BoothNumber>
<BrewerId>17</BrewerId>
<Category>sample string 26</Category>
<City>sample string 3</City>
<Country>sample string 5</Country>
<CustomerName>sample string 9</CustomerName>
<Distance>
<DistanceInMeter>1</DistanceInMeter>
<DistanceInMile>2</DistanceInMile>
</Distance>
<DistanceInMeter>1</DistanceInMeter>
<DistanceInMile>1</DistanceInMile>
<Features xmlns:d4p1="http://schemas.datacontract.org/2004/07/">
<d4p1:Feature>
<d4p1:LocationId>2</d4p1:LocationId>
<d4p1:Name>sample string 1</d4p1:Name>
</d4p1:Feature>
<d4p1:Feature>
<d4p1:LocationId>2</d4p1:LocationId>
<d4p1:Name>sample string 1</d4p1:Name>
</d4p1:Feature>
</Features>
<Id>1</Id>
<Image>sample string 27</Image>
<IsAlreadyInFav>true</IsAlreadyInFav>
<IsAlreadyInWishList>true</IsAlreadyInWishList>
<IsBeerChip>true</IsBeerChip>
<IsFeatrureList>true</IsFeatrureList>
<IsMember>true</IsMember>
<IsProductionOnly>true</IsProductionOnly>
<IsSponsor>true</IsSponsor>
<IsVerified>true</IsVerified>
<IsVisited>true</IsVisited>
<Latitude>1</Latitude>
<Longitude>1</Longitude>
<MemberId>1</MemberId>
<Phone>sample string 7</Phone>
<ProductCount>19</ProductCount>
<State>sample string 4</State>
<Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/">
<d4p1:Tag>
<d4p1:Id>1</d4p1:Id>
<d4p1:LocationId>3</d4p1:LocationId>
<d4p1:Title>sample string 2</d4p1:Title>
</d4p1:Tag>
<d4p1:Tag>
<d4p1:Id>1</d4p1:Id>
<d4p1:LocationId>3</d4p1:LocationId>
<d4p1:Title>sample string 2</d4p1:Title>
</d4p1:Tag>
</Tags>
<Thumb>sample string 10</Thumb>
<Title>sample string 8</Title>
<TitleComputed>sample string 21</TitleComputed>
<WebSite>sample string 22</WebSite>
<ZipCode>sample string 6</ZipCode>
</APILocationV2>
<APILocationV2>
<Address>sample string 2</Address>
<AdvertiseId>13</AdvertiseId>
<AvgRating>11</AvgRating>
<BeerCount>18</BeerCount>
<BoothNumber>sample string 20</BoothNumber>
<BrewerId>17</BrewerId>
<Category>sample string 26</Category>
<City>sample string 3</City>
<Country>sample string 5</Country>
<CustomerName>sample string 9</CustomerName>
<Distance>
<DistanceInMeter>1</DistanceInMeter>
<DistanceInMile>2</DistanceInMile>
</Distance>
<DistanceInMeter>1</DistanceInMeter>
<DistanceInMile>1</DistanceInMile>
<Features xmlns:d4p1="http://schemas.datacontract.org/2004/07/">
<d4p1:Feature>
<d4p1:LocationId>2</d4p1:LocationId>
<d4p1:Name>sample string 1</d4p1:Name>
</d4p1:Feature>
<d4p1:Feature>
<d4p1:LocationId>2</d4p1:LocationId>
<d4p1:Name>sample string 1</d4p1:Name>
</d4p1:Feature>
</Features>
<Id>1</Id>
<Image>sample string 27</Image>
<IsAlreadyInFav>true</IsAlreadyInFav>
<IsAlreadyInWishList>true</IsAlreadyInWishList>
<IsBeerChip>true</IsBeerChip>
<IsFeatrureList>true</IsFeatrureList>
<IsMember>true</IsMember>
<IsProductionOnly>true</IsProductionOnly>
<IsSponsor>true</IsSponsor>
<IsVerified>true</IsVerified>
<IsVisited>true</IsVisited>
<Latitude>1</Latitude>
<Longitude>1</Longitude>
<MemberId>1</MemberId>
<Phone>sample string 7</Phone>
<ProductCount>19</ProductCount>
<State>sample string 4</State>
<Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/">
<d4p1:Tag>
<d4p1:Id>1</d4p1:Id>
<d4p1:LocationId>3</d4p1:LocationId>
<d4p1:Title>sample string 2</d4p1:Title>
</d4p1:Tag>
<d4p1:Tag>
<d4p1:Id>1</d4p1:Id>
<d4p1:LocationId>3</d4p1:LocationId>
<d4p1:Title>sample string 2</d4p1:Title>
</d4p1:Tag>
</Tags>
<Thumb>sample string 10</Thumb>
<Title>sample string 8</Title>
<TitleComputed>sample string 21</TitleComputed>
<WebSite>sample string 22</WebSite>
<ZipCode>sample string 6</ZipCode>
</APILocationV2>
</List>
<TotalRecords>1</TotalRecords>
</APILocationResponse>