GET Brands?includeProperties={includeProperties}&includeCountries={includeCountries}

Get all Brands

Request Information

URI Parameters

NameDescriptionTypeAdditional information
includeProperties

boolean

Default value is False

includeCountries

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

List of BrandModel

Collection of OutputBrandModel
NameDescriptionTypeAdditional information
BrandID

integer

None.

BrandGroupID

integer

None.

CountryIDs

Collection of integer

None.

Properties

Dictionary of string [key] and string [value]

None.

Name

string

Required

String length: inclusive between 3 and 64

BrandType

BrandType

Required

PanelTypeID

byte

Required

DefaultMinAge

byte

Required

Range: inclusive between 0 and 125

DefaultMaxAge

byte

Required

Range: inclusive between 0 and 125

IsNewUserRegistrationAllowed

boolean

None.

UserNameValidationRegEx

string

None.

PasswordValidationRegEx

string

None.

MemberTypeID

byte

Required

AllowSoiRegistration

boolean

None.

Description

string

String length: inclusive between 0 and 250

TranslationKey

globally unique identifier

None.

IncentiveModeID

integer

None.

SurveyEarningType

SurveyEarningType

None.

FailWhenAddressValidationFails

boolean

None.

RegistrationHighVolumeLimit

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "BrandID": 1,
    "BrandGroupID": 2,
    "CountryIDs": [
      1,
      2
    ],
    "Properties": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Name": "sample string 3",
    "BrandType": 1,
    "PanelTypeID": 64,
    "DefaultMinAge": 64,
    "DefaultMaxAge": 64,
    "IsNewUserRegistrationAllowed": true,
    "UserNameValidationRegEx": "sample string 8",
    "PasswordValidationRegEx": "sample string 9",
    "MemberTypeID": 64,
    "AllowSoiRegistration": true,
    "Description": "sample string 12",
    "TranslationKey": "dc6c8e6b-8c03-4450-aa6e-195bf6ec553e",
    "IncentiveModeID": 1,
    "SurveyEarningType": 1,
    "FailWhenAddressValidationFails": true,
    "RegistrationHighVolumeLimit": 1
  },
  {
    "BrandID": 1,
    "BrandGroupID": 2,
    "CountryIDs": [
      1,
      2
    ],
    "Properties": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Name": "sample string 3",
    "BrandType": 1,
    "PanelTypeID": 64,
    "DefaultMinAge": 64,
    "DefaultMaxAge": 64,
    "IsNewUserRegistrationAllowed": true,
    "UserNameValidationRegEx": "sample string 8",
    "PasswordValidationRegEx": "sample string 9",
    "MemberTypeID": 64,
    "AllowSoiRegistration": true,
    "Description": "sample string 12",
    "TranslationKey": "dc6c8e6b-8c03-4450-aa6e-195bf6ec553e",
    "IncentiveModeID": 1,
    "SurveyEarningType": 1,
    "FailWhenAddressValidationFails": true,
    "RegistrationHighVolumeLimit": 1
  }
]

text/html

Sample:
[{"BrandID":1,"BrandGroupID":2,"CountryIDs":[1,2],"Properties":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"Name":"sample string 3","BrandType":1,"PanelTypeID":64,"DefaultMinAge":64,"DefaultMaxAge":64,"IsNewUserRegistrationAllowed":true,"UserNameValidationRegEx":"sample string 8","PasswordValidationRegEx":"sample string 9","MemberTypeID":64,"AllowSoiRegistration":true,"Description":"sample string 12","TranslationKey":"dc6c8e6b-8c03-4450-aa6e-195bf6ec553e","IncentiveModeID":1,"SurveyEarningType":1,"FailWhenAddressValidationFails":true,"RegistrationHighVolumeLimit":1},{"BrandID":1,"BrandGroupID":2,"CountryIDs":[1,2],"Properties":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"Name":"sample string 3","BrandType":1,"PanelTypeID":64,"DefaultMinAge":64,"DefaultMaxAge":64,"IsNewUserRegistrationAllowed":true,"UserNameValidationRegEx":"sample string 8","PasswordValidationRegEx":"sample string 9","MemberTypeID":64,"AllowSoiRegistration":true,"Description":"sample string 12","TranslationKey":"dc6c8e6b-8c03-4450-aa6e-195bf6ec553e","IncentiveModeID":1,"SurveyEarningType":1,"FailWhenAddressValidationFails":true,"RegistrationHighVolumeLimit":1}]

application/xml, text/xml

Sample:
<ArrayOfOutputBrandModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.BrandStore">
  <OutputBrandModel>
    <AllowSoiRegistration>true</AllowSoiRegistration>
    <BrandType>Private</BrandType>
    <DefaultMaxAge>64</DefaultMaxAge>
    <DefaultMinAge>64</DefaultMinAge>
    <Description>sample string 12</Description>
    <FailWhenAddressValidationFails>true</FailWhenAddressValidationFails>
    <IncentiveModeID>1</IncentiveModeID>
    <IsNewUserRegistrationAllowed>true</IsNewUserRegistrationAllowed>
    <MemberTypeID>64</MemberTypeID>
    <Name>sample string 3</Name>
    <PanelTypeID>64</PanelTypeID>
    <PasswordValidationRegEx>sample string 9</PasswordValidationRegEx>
    <RegistrationHighVolumeLimit>1</RegistrationHighVolumeLimit>
    <SurveyEarningType>TIG</SurveyEarningType>
    <TranslationKey>dc6c8e6b-8c03-4450-aa6e-195bf6ec553e</TranslationKey>
    <UserNameValidationRegEx>sample string 8</UserNameValidationRegEx>
    <BrandGroupID>2</BrandGroupID>
    <BrandID>1</BrandID>
    <CountryIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </CountryIDs>
    <Properties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Properties>
  </OutputBrandModel>
  <OutputBrandModel>
    <AllowSoiRegistration>true</AllowSoiRegistration>
    <BrandType>Private</BrandType>
    <DefaultMaxAge>64</DefaultMaxAge>
    <DefaultMinAge>64</DefaultMinAge>
    <Description>sample string 12</Description>
    <FailWhenAddressValidationFails>true</FailWhenAddressValidationFails>
    <IncentiveModeID>1</IncentiveModeID>
    <IsNewUserRegistrationAllowed>true</IsNewUserRegistrationAllowed>
    <MemberTypeID>64</MemberTypeID>
    <Name>sample string 3</Name>
    <PanelTypeID>64</PanelTypeID>
    <PasswordValidationRegEx>sample string 9</PasswordValidationRegEx>
    <RegistrationHighVolumeLimit>1</RegistrationHighVolumeLimit>
    <SurveyEarningType>TIG</SurveyEarningType>
    <TranslationKey>dc6c8e6b-8c03-4450-aa6e-195bf6ec553e</TranslationKey>
    <UserNameValidationRegEx>sample string 8</UserNameValidationRegEx>
    <BrandGroupID>2</BrandGroupID>
    <BrandID>1</BrandID>
    <CountryIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </CountryIDs>
    <Properties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Properties>
  </OutputBrandModel>
</ArrayOfOutputBrandModel>

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.