GET SiteIncentivesActivity?brandID={brandID}&internalName={internalName}

Get Site Incentives Activity for the Brand by it's internal name.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
brandID

integer

Required

internalName

string

Required

Body Parameters

None.

Response Information

Resource Description

Output Site Incentives Activity Model

OutputSiteIncentivesActivityModel
NameDescriptionTypeAdditional information
SiteIncentivesActivityID

integer

None.

MemberDisplayKey

string

None.

BrandID

integer

Required

Range: inclusive between 1 and 32767

InternalName

string

Required

Max length: 64

InternalDisplay

string

Required

Max length: 256

MemberDisplay

string

Required

Max length: 128

DefaultCredit

decimal number

Required

Range: inclusive between 4.94065645841247E-324 and 1.79769313486232E+308

IsActive

boolean

Required

ReferenceCode1

string

Max length: 32

ReferenceCode2

string

Max length: 32

Description

string

Max length: 512

Response Formats

application/json, text/json

Sample:
{
  "SiteIncentivesActivityID": 1,
  "MemberDisplayKey": "sample string 2",
  "BrandID": 3,
  "InternalName": "sample string 4",
  "InternalDisplay": "sample string 5",
  "MemberDisplay": "sample string 6",
  "DefaultCredit": 7.1,
  "IsActive": true,
  "ReferenceCode1": "sample string 9",
  "ReferenceCode2": "sample string 10",
  "Description": "sample string 11"
}

text/html

Sample:
{"SiteIncentivesActivityID":1,"MemberDisplayKey":"sample string 2","BrandID":3,"InternalName":"sample string 4","InternalDisplay":"sample string 5","MemberDisplay":"sample string 6","DefaultCredit":7.1,"IsActive":true,"ReferenceCode1":"sample string 9","ReferenceCode2":"sample string 10","Description":"sample string 11"}

application/xml, text/xml

Sample:
<OutputSiteIncentivesActivityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.Incentives">
  <DefaultCredit>7.1</DefaultCredit>
  <Description>sample string 11</Description>
  <InternalDisplay>sample string 5</InternalDisplay>
  <IsActive>true</IsActive>
  <MemberDisplay>sample string 6</MemberDisplay>
  <ReferenceCode1>sample string 9</ReferenceCode1>
  <ReferenceCode2>sample string 10</ReferenceCode2>
  <BrandID>3</BrandID>
  <InternalName>sample string 4</InternalName>
  <MemberDisplayKey>sample string 2</MemberDisplayKey>
  <SiteIncentivesActivityID>1</SiteIncentivesActivityID>
</OutputSiteIncentivesActivityModel>

application/bson

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