PUT Brands

Update Brand

Request Information

URI Parameters

None.

Body Parameters

UpdateBrandModel
NameDescriptionTypeAdditional information
BrandID

integer

Required

Name

string

Required

String length: inclusive between 3 and 64

DefaultMinAge

integer

Required

Range: inclusive between 0 and 125

DefaultMaxAge

integer

Required

Range: inclusive between 0 and 125

IsNewUserRegistrationAllowed

boolean

Required

AllowSoiRegistration

boolean

Required

UserNameValidationRegEx

string

None.

PasswordValidationRegEx

string

None.

Description

string

None.

TranslationKey

globally unique identifier

None.

IncentiveModeID

integer

None.

SurveyEarningType

SurveyEarningType

None.

FailWhenAddressValidationFails

boolean

None.

RegistrationHighVolumeLimit

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "BrandID": 1,
  "Name": "sample string 2",
  "DefaultMinAge": 3,
  "DefaultMaxAge": 4,
  "IsNewUserRegistrationAllowed": true,
  "AllowSoiRegistration": true,
  "UserNameValidationRegEx": "sample string 7",
  "PasswordValidationRegEx": "sample string 8",
  "Description": "sample string 9",
  "TranslationKey": "4780a737-c6f6-417d-b08b-f6b59bcf8f96",
  "IncentiveModeID": 1,
  "SurveyEarningType": 1,
  "FailWhenAddressValidationFails": true,
  "RegistrationHighVolumeLimit": 1
}

text/html

Sample:
{"BrandID":1,"Name":"sample string 2","DefaultMinAge":3,"DefaultMaxAge":4,"IsNewUserRegistrationAllowed":true,"AllowSoiRegistration":true,"UserNameValidationRegEx":"sample string 7","PasswordValidationRegEx":"sample string 8","Description":"sample string 9","TranslationKey":"4780a737-c6f6-417d-b08b-f6b59bcf8f96","IncentiveModeID":1,"SurveyEarningType":1,"FailWhenAddressValidationFails":true,"RegistrationHighVolumeLimit":1}

application/xml, text/xml

Sample:
<UpdateBrandModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.BrandStore">
  <AllowSoiRegistration>true</AllowSoiRegistration>
  <BrandID>1</BrandID>
  <DefaultMaxAge>4</DefaultMaxAge>
  <DefaultMinAge>3</DefaultMinAge>
  <Description>sample string 9</Description>
  <FailWhenAddressValidationFails>true</FailWhenAddressValidationFails>
  <IncentiveModeID>1</IncentiveModeID>
  <IsNewUserRegistrationAllowed>true</IsNewUserRegistrationAllowed>
  <Name>sample string 2</Name>
  <PasswordValidationRegEx>sample string 8</PasswordValidationRegEx>
  <RegistrationHighVolumeLimit>1</RegistrationHighVolumeLimit>
  <SurveyEarningType>TIG</SurveyEarningType>
  <TranslationKey>4780a737-c6f6-417d-b08b-f6b59bcf8f96</TranslationKey>
  <UserNameValidationRegEx>sample string 7</UserNameValidationRegEx>
</UpdateBrandModel>

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 'UpdateBrandModel'.

application/bson

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

Response Information

Resource Description

BrandStoreResult
NameDescriptionTypeAdditional information
Succeeded

boolean

None.

Errors

Collection of string

None.

ErrorCode

APIErrorCodes

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 0,
  "Succeeded": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:
{"ErrorCode":0,"Succeeded":true,"Errors":["sample string 1","sample string 2"]}

application/bson

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