PUT api/Content/v2/GetRegions

Request Information

URI Parameters

None.

Body Parameters

APIRegionRequest
NameDescriptionTypeAdditional information
CustomerId

integer

None.

UniqueId

globally unique identifier

None.

UserUniqueId

integer

None.

PageNumber

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerId": 1,
  "UniqueId": "237ffcde-d1e9-461a-9925-b6feb112e355",
  "UserUniqueId": 3,
  "PageNumber": 4
}

application/xml, text/xml

Sample:
<APIRegionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <CustomerId>1</CustomerId>
  <PageNumber>4</PageNumber>
  <UniqueId>237ffcde-d1e9-461a-9925-b6feb112e355</UniqueId>
  <UserUniqueId>3</UserUniqueId>
</APIRegionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIRegionResponse
NameDescriptionTypeAdditional information
List

Collection of APIRegion

None.

TotalCounts

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "List": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Image": "sample string 3",
      "Description": "sample string 4",
      "CreatedDate": 5,
      "TotalBreweries": 6
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Image": "sample string 3",
      "Description": "sample string 4",
      "CreatedDate": 5,
      "TotalBreweries": 6
    }
  ],
  "TotalCounts": 1
}

application/xml, text/xml

Sample:
<APIRegionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <List>
    <APIRegion>
      <CreatedDate>5</CreatedDate>
      <Description>sample string 4</Description>
      <Id>1</Id>
      <Image>sample string 3</Image>
      <Name>sample string 2</Name>
      <TotalBreweries>6</TotalBreweries>
    </APIRegion>
    <APIRegion>
      <CreatedDate>5</CreatedDate>
      <Description>sample string 4</Description>
      <Id>1</Id>
      <Image>sample string 3</Image>
      <Name>sample string 2</Name>
      <TotalBreweries>6</TotalBreweries>
    </APIRegion>
  </List>
  <TotalCounts>1</TotalCounts>
</APIRegionResponse>