POST Brands?brandGroupID={brandGroupID}

Create Brand for a given Brand Group ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
brandGroupID

Brand Group ID

integer

Required

Body Parameters

Brand Model contains Name, Brand Type, Panel Type, Default Min and Max age, AllowNewUserRegistration, UserNameValidationRegEx, PasswordValidationRegEx, MemberType, BrandGroupID, Properties and list of brand countries

BaseBrandModel
NameDescriptionTypeAdditional information
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.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "BrandType": 1,
  "PanelTypeID": 64,
  "DefaultMinAge": 64,
  "DefaultMaxAge": 64,
  "IsNewUserRegistrationAllowed": true,
  "UserNameValidationRegEx": "sample string 6",
  "PasswordValidationRegEx": "sample string 7",
  "MemberTypeID": 64,
  "AllowSoiRegistration": true,
  "Description": "sample string 10",
  "TranslationKey": "4dd5287d-ee02-4757-9115-a79af016e211",
  "IncentiveModeID": 1,
  "SurveyEarningType": 1,
  "FailWhenAddressValidationFails": true,
  "RegistrationHighVolumeLimit": 1
}

text/html

Sample:
{"Name":"sample string 1","BrandType":1,"PanelTypeID":64,"DefaultMinAge":64,"DefaultMaxAge":64,"IsNewUserRegistrationAllowed":true,"UserNameValidationRegEx":"sample string 6","PasswordValidationRegEx":"sample string 7","MemberTypeID":64,"AllowSoiRegistration":true,"Description":"sample string 10","TranslationKey":"4dd5287d-ee02-4757-9115-a79af016e211","IncentiveModeID":1,"SurveyEarningType":1,"FailWhenAddressValidationFails":true,"RegistrationHighVolumeLimit":1}

application/xml, text/xml

Sample:
<BaseBrandModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.BrandStore">
  <AllowSoiRegistration>true</AllowSoiRegistration>
  <BrandType>Private</BrandType>
  <DefaultMaxAge>64</DefaultMaxAge>
  <DefaultMinAge>64</DefaultMinAge>
  <Description>sample string 10</Description>
  <FailWhenAddressValidationFails>true</FailWhenAddressValidationFails>
  <IncentiveModeID>1</IncentiveModeID>
  <IsNewUserRegistrationAllowed>true</IsNewUserRegistrationAllowed>
  <MemberTypeID>64</MemberTypeID>
  <Name>sample string 1</Name>
  <PanelTypeID>64</PanelTypeID>
  <PasswordValidationRegEx>sample string 7</PasswordValidationRegEx>
  <RegistrationHighVolumeLimit>1</RegistrationHighVolumeLimit>
  <SurveyEarningType>TIG</SurveyEarningType>
  <TranslationKey>4dd5287d-ee02-4757-9115-a79af016e211</TranslationKey>
  <UserNameValidationRegEx>sample string 6</UserNameValidationRegEx>
</BaseBrandModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BaseBrandModel'.

application/bson

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

Response Information

Resource Description

BrandModel

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": "34562186-1503-44a5-a618-43e9d983d332",
  "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":"34562186-1503-44a5-a618-43e9d983d332","IncentiveModeID":1,"SurveyEarningType":1,"FailWhenAddressValidationFails":true,"RegistrationHighVolumeLimit":1}

application/xml, text/xml

Sample:
<OutputBrandModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.BrandStore">
  <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>34562186-1503-44a5-a618-43e9d983d332</TranslationKey>
  <UserNameValidationRegEx>sample string 8</UserNameValidationRegEx>
  <BrandGroupID>2</BrandGroupID>
  <BrandID>1</BrandID>
  <CountryIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CountryIDs>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
</OutputBrandModel>

application/bson

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