GET Brands/{brandID}/TieredIncentivesGrid

Get default Tiered Incentives Grid for the Brand.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
brandID

Brand ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Output Tiered Incentives Grid Model

OutputTieredIncentivesGridModel
NameDescriptionTypeAdditional information
TieredIncentivesGridID

integer

None.

BrandID

integer

None.

CountryID

integer

None.

Levels

Collection of TIGLevelModel

Required

AllowedSurveyStatuses

Collection of SurveyParticipationStatus

Required

Response Formats

application/json, text/json

Sample:
{
  "TieredIncentivesGridID": 1,
  "BrandID": 2,
  "CountryID": 3,
  "Levels": [
    {
      "Level": 64,
      "SubLevels": [
        {
          "SubLevel": 64,
          "Values": [
            {
              "SurveyStatus": 1,
              "CreditValue": 1.1
            },
            {
              "SurveyStatus": 1,
              "CreditValue": 1.1
            }
          ]
        },
        {
          "SubLevel": 64,
          "Values": [
            {
              "SurveyStatus": 1,
              "CreditValue": 1.1
            },
            {
              "SurveyStatus": 1,
              "CreditValue": 1.1
            }
          ]
        }
      ]
    },
    {
      "Level": 64,
      "SubLevels": [
        {
          "SubLevel": 64,
          "Values": [
            {
              "SurveyStatus": 1,
              "CreditValue": 1.1
            },
            {
              "SurveyStatus": 1,
              "CreditValue": 1.1
            }
          ]
        },
        {
          "SubLevel": 64,
          "Values": [
            {
              "SurveyStatus": 1,
              "CreditValue": 1.1
            },
            {
              "SurveyStatus": 1,
              "CreditValue": 1.1
            }
          ]
        }
      ]
    }
  ],
  "AllowedSurveyStatuses": [
    1,
    1
  ]
}

text/html

Sample:
{"TieredIncentivesGridID":1,"BrandID":2,"CountryID":3,"Levels":[{"Level":64,"SubLevels":[{"SubLevel":64,"Values":[{"SurveyStatus":1,"CreditValue":1.1},{"SurveyStatus":1,"CreditValue":1.1}]},{"SubLevel":64,"Values":[{"SurveyStatus":1,"CreditValue":1.1},{"SurveyStatus":1,"CreditValue":1.1}]}]},{"Level":64,"SubLevels":[{"SubLevel":64,"Values":[{"SurveyStatus":1,"CreditValue":1.1},{"SurveyStatus":1,"CreditValue":1.1}]},{"SubLevel":64,"Values":[{"SurveyStatus":1,"CreditValue":1.1},{"SurveyStatus":1,"CreditValue":1.1}]}]}],"AllowedSurveyStatuses":[1,1]}

application/xml, text/xml

Sample:
<OutputTieredIncentivesGridModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.Incentives">
  <AllowedSurveyStatuses>
    <SurveyParticipationStatus>Complete</SurveyParticipationStatus>
    <SurveyParticipationStatus>Complete</SurveyParticipationStatus>
  </AllowedSurveyStatuses>
  <Levels>
    <TIGLevelModel>
      <Level>64</Level>
      <SubLevels>
        <TIGSubLevelModel>
          <SubLevel>64</SubLevel>
          <Values>
            <TIGValueModel>
              <CreditValue>1.1</CreditValue>
              <SurveyStatus>Complete</SurveyStatus>
            </TIGValueModel>
            <TIGValueModel>
              <CreditValue>1.1</CreditValue>
              <SurveyStatus>Complete</SurveyStatus>
            </TIGValueModel>
          </Values>
        </TIGSubLevelModel>
        <TIGSubLevelModel>
          <SubLevel>64</SubLevel>
          <Values>
            <TIGValueModel>
              <CreditValue>1.1</CreditValue>
              <SurveyStatus>Complete</SurveyStatus>
            </TIGValueModel>
            <TIGValueModel>
              <CreditValue>1.1</CreditValue>
              <SurveyStatus>Complete</SurveyStatus>
            </TIGValueModel>
          </Values>
        </TIGSubLevelModel>
      </SubLevels>
    </TIGLevelModel>
    <TIGLevelModel>
      <Level>64</Level>
      <SubLevels>
        <TIGSubLevelModel>
          <SubLevel>64</SubLevel>
          <Values>
            <TIGValueModel>
              <CreditValue>1.1</CreditValue>
              <SurveyStatus>Complete</SurveyStatus>
            </TIGValueModel>
            <TIGValueModel>
              <CreditValue>1.1</CreditValue>
              <SurveyStatus>Complete</SurveyStatus>
            </TIGValueModel>
          </Values>
        </TIGSubLevelModel>
        <TIGSubLevelModel>
          <SubLevel>64</SubLevel>
          <Values>
            <TIGValueModel>
              <CreditValue>1.1</CreditValue>
              <SurveyStatus>Complete</SurveyStatus>
            </TIGValueModel>
            <TIGValueModel>
              <CreditValue>1.1</CreditValue>
              <SurveyStatus>Complete</SurveyStatus>
            </TIGValueModel>
          </Values>
        </TIGSubLevelModel>
      </SubLevels>
    </TIGLevelModel>
  </Levels>
  <BrandID>2</BrandID>
  <CountryID>3</CountryID>
  <TieredIncentivesGridID>1</TieredIncentivesGridID>
</OutputTieredIncentivesGridModel>

application/bson

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