PUT api/Content/v3/GetLocations

Request Information

URI Parameters

None.

Body Parameters

APILocationRequest
NameDescriptionTypeAdditional information
Latitude

decimal number

None.

Longitude

decimal number

None.

Miles

integer

None.

Meter

integer

None.

SortBy

string

None.

SortDir

string

None.

PageNumber

integer

None.

BeerId

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.

Request Formats

application/json, text/json

Sample:
{
  "Latitude": 1.0,
  "Longitude": 2.0,
  "Miles": 3,
  "Meter": 4,
  "SortBy": "sample string 5",
  "SortDir": "sample string 6",
  "PageNumber": 7,
  "BeerId": 8,
  "CustomerId": 9,
  "UniqueId": "8e233940-655c-4001-88a7-68407ff6487f",
  "UserUniqueId": 11,
  "MemberId": 12,
  "SearchText": "sample string 13",
  "IsMapView": true,
  "CategoryId": 15,
  "OnlyMainLocation": true,
  "EventId": 16,
  "RegionId": 17,
  "FestivalId": 18,
  "OnlyAssociation": true,
  "ProgramId": 20
}

application/xml, text/xml

Sample:
<APILocationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <BeerId>8</BeerId>
  <CategoryId>15</CategoryId>
  <CustomerId>9</CustomerId>
  <EventId>16</EventId>
  <FestivalId>18</FestivalId>
  <IsMapView>true</IsMapView>
  <Latitude>1</Latitude>
  <Longitude>2</Longitude>
  <MemberId>12</MemberId>
  <Meter>4</Meter>
  <Miles>3</Miles>
  <OnlyAssociation>true</OnlyAssociation>
  <OnlyMainLocation>true</OnlyMainLocation>
  <PageNumber>7</PageNumber>
  <ProgramId>20</ProgramId>
  <RegionId>17</RegionId>
  <SearchText>sample string 13</SearchText>
  <SortBy>sample string 5</SortBy>
  <SortDir>sample string 6</SortDir>
  <UniqueId>8e233940-655c-4001-88a7-68407ff6487f</UniqueId>
  <UserUniqueId>11</UserUniqueId>
</APILocationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APILocationResponse
NameDescriptionTypeAdditional 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,
      "IsVerified": true,
      "BrewerId": 16,
      "BeerCount": 17,
      "BoothNumber": "sample string 18",
      "TitleComputed": "sample string 19",
      "WebSite": "sample string 20",
      "IsBeerChip": true,
      "IsSponsor": true,
      "IsVisited": true,
      "Category": "sample string 24"
    },
    {
      "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,
      "IsVerified": true,
      "BrewerId": 16,
      "BeerCount": 17,
      "BoothNumber": "sample string 18",
      "TitleComputed": "sample string 19",
      "WebSite": "sample string 20",
      "IsBeerChip": true,
      "IsSponsor": true,
      "IsVisited": true,
      "Category": "sample string 24"
    }
  ],
  "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>17</BeerCount>
      <BoothNumber>sample string 18</BoothNumber>
      <BrewerId>16</BrewerId>
      <Category>sample string 24</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>
      <Id>1</Id>
      <IsAlreadyInFav>true</IsAlreadyInFav>
      <IsBeerChip>true</IsBeerChip>
      <IsFeatrureList>true</IsFeatrureList>
      <IsSponsor>true</IsSponsor>
      <IsVerified>true</IsVerified>
      <IsVisited>true</IsVisited>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <MemberId>1</MemberId>
      <Phone>sample string 7</Phone>
      <State>sample string 4</State>
      <Thumb>sample string 10</Thumb>
      <Title>sample string 8</Title>
      <TitleComputed>sample string 19</TitleComputed>
      <WebSite>sample string 20</WebSite>
      <ZipCode>sample string 6</ZipCode>
    </APILocationV2>
    <APILocationV2>
      <Address>sample string 2</Address>
      <AdvertiseId>13</AdvertiseId>
      <AvgRating>11</AvgRating>
      <BeerCount>17</BeerCount>
      <BoothNumber>sample string 18</BoothNumber>
      <BrewerId>16</BrewerId>
      <Category>sample string 24</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>
      <Id>1</Id>
      <IsAlreadyInFav>true</IsAlreadyInFav>
      <IsBeerChip>true</IsBeerChip>
      <IsFeatrureList>true</IsFeatrureList>
      <IsSponsor>true</IsSponsor>
      <IsVerified>true</IsVerified>
      <IsVisited>true</IsVisited>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <MemberId>1</MemberId>
      <Phone>sample string 7</Phone>
      <State>sample string 4</State>
      <Thumb>sample string 10</Thumb>
      <Title>sample string 8</Title>
      <TitleComputed>sample string 19</TitleComputed>
      <WebSite>sample string 20</WebSite>
      <ZipCode>sample string 6</ZipCode>
    </APILocationV2>
  </List>
  <TotalRecords>1</TotalRecords>
</APILocationResponse>