PUT api/Content/v3/GetBeers

Request Information

URI Parameters

None.

Body Parameters

APIBeerRequest
NameDescriptionTypeAdditional information
SortBy

string

None.

SortDir

string

None.

PageNumber

integer

None.

CustomerId

integer

None.

UniqueId

globally unique identifier

None.

UserUniqueId

integer

None.

MemberId

integer

None.

SearchText

string

None.

CategoryId

integer

None.

BrewerId

integer

None.

BeerStyleId

string

None.

IsOrganic

boolean

None.

LanguageCode

string

None.

IsRecent

boolean

None.

IsSuggested

boolean

None.

FestivalId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SortBy": "sample string 1",
  "SortDir": "sample string 2",
  "PageNumber": 3,
  "CustomerId": 4,
  "UniqueId": "0b70bdcb-9e19-4066-9278-b21ced54556a",
  "UserUniqueId": 6,
  "MemberId": 7,
  "SearchText": "sample string 8",
  "CategoryId": 9,
  "BrewerId": 10,
  "BeerStyleId": "sample string 11",
  "IsOrganic": true,
  "LanguageCode": "sample string 13",
  "IsRecent": true,
  "IsSuggested": true,
  "FestivalId": 16
}

application/xml, text/xml

Sample:
<APIBeerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <BeerStyleId>sample string 11</BeerStyleId>
  <BrewerId>10</BrewerId>
  <CategoryId>9</CategoryId>
  <CustomerId>4</CustomerId>
  <FestivalId>16</FestivalId>
  <IsOrganic>true</IsOrganic>
  <IsRecent>true</IsRecent>
  <IsSuggested>true</IsSuggested>
  <LanguageCode>sample string 13</LanguageCode>
  <MemberId>7</MemberId>
  <PageNumber>3</PageNumber>
  <SearchText>sample string 8</SearchText>
  <SortBy>sample string 1</SortBy>
  <SortDir>sample string 2</SortDir>
  <UniqueId>0b70bdcb-9e19-4066-9278-b21ced54556a</UniqueId>
  <UserUniqueId>6</UserUniqueId>
</APIBeerRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIBeerResponse
NameDescriptionTypeAdditional information
List

Collection of APIBeerV2

None.

TotalRecords

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "List": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "CustomerId": 1,
      "CustomerName": "sample string 3",
      "OriginalImage": "sample string 4",
      "Thumb": "sample string 5",
      "Description": "sample string 6",
      "Logo": "sample string 7",
      "CreatedDate": 8,
      "BeerStyle": "sample string 9",
      "ABV": "sample string 10",
      "IBU": "sample string 11",
      "IsOrganic": true,
      "Sequence": 1,
      "AvgRating": 13.0,
      "IsFeatrureList": true,
      "AdvertiseId": 15,
      "IsAlreadyInFav": true,
      "IsAlreadyInWishList": true,
      "IsVerified": true,
      "IsAssociation": true,
      "BrewerId": 1,
      "BrewerName": "sample string 20",
      "IsFestivalBeer": true,
      "BoothNumber": "sample string 22",
      "Beer_Computed": "sample string 23",
      "Brewer_Computed": "sample string 24",
      "City": "sample string 25",
      "State": "sample string 26",
      "UserName": "sample string 27"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "CustomerId": 1,
      "CustomerName": "sample string 3",
      "OriginalImage": "sample string 4",
      "Thumb": "sample string 5",
      "Description": "sample string 6",
      "Logo": "sample string 7",
      "CreatedDate": 8,
      "BeerStyle": "sample string 9",
      "ABV": "sample string 10",
      "IBU": "sample string 11",
      "IsOrganic": true,
      "Sequence": 1,
      "AvgRating": 13.0,
      "IsFeatrureList": true,
      "AdvertiseId": 15,
      "IsAlreadyInFav": true,
      "IsAlreadyInWishList": true,
      "IsVerified": true,
      "IsAssociation": true,
      "BrewerId": 1,
      "BrewerName": "sample string 20",
      "IsFestivalBeer": true,
      "BoothNumber": "sample string 22",
      "Beer_Computed": "sample string 23",
      "Brewer_Computed": "sample string 24",
      "City": "sample string 25",
      "State": "sample string 26",
      "UserName": "sample string 27"
    }
  ],
  "TotalRecords": 1
}

application/xml, text/xml

Sample:
<APIBeerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <List>
    <APIBeerV2>
      <ABV>sample string 10</ABV>
      <AdvertiseId>15</AdvertiseId>
      <AvgRating>13</AvgRating>
      <BeerStyle>sample string 9</BeerStyle>
      <Beer_Computed>sample string 23</Beer_Computed>
      <BoothNumber>sample string 22</BoothNumber>
      <BrewerId>1</BrewerId>
      <BrewerName>sample string 20</BrewerName>
      <Brewer_Computed>sample string 24</Brewer_Computed>
      <City>sample string 25</City>
      <CreatedDate>8</CreatedDate>
      <CustomerId>1</CustomerId>
      <CustomerName>sample string 3</CustomerName>
      <Description>sample string 6</Description>
      <IBU>sample string 11</IBU>
      <Id>1</Id>
      <IsAlreadyInFav>true</IsAlreadyInFav>
      <IsAlreadyInWishList>true</IsAlreadyInWishList>
      <IsAssociation>true</IsAssociation>
      <IsFeatrureList>true</IsFeatrureList>
      <IsFestivalBeer>true</IsFestivalBeer>
      <IsOrganic>true</IsOrganic>
      <IsVerified>true</IsVerified>
      <Logo>sample string 7</Logo>
      <Name>sample string 2</Name>
      <OriginalImage>sample string 4</OriginalImage>
      <Sequence>1</Sequence>
      <State>sample string 26</State>
      <Thumb>sample string 5</Thumb>
      <UserName>sample string 27</UserName>
    </APIBeerV2>
    <APIBeerV2>
      <ABV>sample string 10</ABV>
      <AdvertiseId>15</AdvertiseId>
      <AvgRating>13</AvgRating>
      <BeerStyle>sample string 9</BeerStyle>
      <Beer_Computed>sample string 23</Beer_Computed>
      <BoothNumber>sample string 22</BoothNumber>
      <BrewerId>1</BrewerId>
      <BrewerName>sample string 20</BrewerName>
      <Brewer_Computed>sample string 24</Brewer_Computed>
      <City>sample string 25</City>
      <CreatedDate>8</CreatedDate>
      <CustomerId>1</CustomerId>
      <CustomerName>sample string 3</CustomerName>
      <Description>sample string 6</Description>
      <IBU>sample string 11</IBU>
      <Id>1</Id>
      <IsAlreadyInFav>true</IsAlreadyInFav>
      <IsAlreadyInWishList>true</IsAlreadyInWishList>
      <IsAssociation>true</IsAssociation>
      <IsFeatrureList>true</IsFeatrureList>
      <IsFestivalBeer>true</IsFestivalBeer>
      <IsOrganic>true</IsOrganic>
      <IsVerified>true</IsVerified>
      <Logo>sample string 7</Logo>
      <Name>sample string 2</Name>
      <OriginalImage>sample string 4</OriginalImage>
      <Sequence>1</Sequence>
      <State>sample string 26</State>
      <Thumb>sample string 5</Thumb>
      <UserName>sample string 27</UserName>
    </APIBeerV2>
  </List>
  <TotalRecords>1</TotalRecords>
</APIBeerResponse>