POST api/Decisions/Contexts/{clientID}/{contextName}?slotName={slotName}&returnAll={returnAll}

Requests multiple decision results for a given context. The visitor identity is determined based on the supplied keys

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientID

Client ID

globally unique identifier

Required

contextName

Context name

string

Required

slotName

Slot name

string

Default value is

returnAll

If no slot name is provided, returnAll controls if all content decisions are returned or just the default

boolean

Default value is False

Body Parameters

Request details with identity parameters

DecisionRequestWithIdentityLookup
NameDescriptionTypeAdditional information
Identity

Identity lookup

IdentityLookup

None.

DecisionRequest

Decision request

DynamicContentRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "Identity": {
    "VisitorID": "sample string 1",
    "IdentityKeys": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  "DecisionRequest": {
    "NumberOfResults": 1,
    "ApplyNumberResultsToNested": true,
    "DeviceID": "sample string 2",
    "PublishID": "sample string 3",
    "MinuteOffsetUTC": 1,
    "APIContext": "sample string 4",
    "IsMasterMessage": true,
    "Attributes": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "Geolocation": {
      "Longitude": "sample string 1",
      "Latitude": "sample string 2"
    }
  }
}

application/xml, text/xml

Sample:
<DecisionRequestWithIdentityLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RedPoint.InteractionRealtime.Models">
  <DecisionRequest>
    <APIContext>sample string 4</APIContext>
    <ApplyNumberResultsToNested>true</ApplyNumberResultsToNested>
    <Attributes>
      <VisitorAttribute>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </VisitorAttribute>
      <VisitorAttribute>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </VisitorAttribute>
    </Attributes>
    <DeviceID>sample string 2</DeviceID>
    <Geolocation>
      <Latitude>sample string 2</Latitude>
      <Longitude>sample string 1</Longitude>
    </Geolocation>
    <IsMasterMessage>true</IsMasterMessage>
    <MinuteOffsetUTC>1</MinuteOffsetUTC>
    <NumberOfResults>1</NumberOfResults>
    <PublishID>sample string 3</PublishID>
  </DecisionRequest>
  <Identity>
    <IdentityKeys 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>
    </IdentityKeys>
    <VisitorID>sample string 1</VisitorID>
  </Identity>
</DecisionRequestWithIdentityLookup>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DecisionResult
NameDescriptionTypeAdditional information
ContentName

string

None.

ResultID

globally unique identifier

None.

ContentID

string

None.

Result

string

None.

ResultContent

Object

None.

ResultContentXML

XElement

None.

ContentFormat

DecisionContentFormat

None.

IsCachedContent

boolean

None.

DefaultKey

string

None.

DivName

string

None.

ContentPath

string

None.

IsEmptyResult

boolean

None.

PluginTag

string

None.

PluginTagDefault

string

None.

ContextName

string

None.

SlotName

string

None.

VisitorID

string

None.

DecisionType

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ContentName": "sample string 1",
    "ResultID": "7962bcd3-04bd-4ed0-ba64-c577459ca256",
    "ContentID": "sample string 3",
    "Result": "sample string 4",
    "ResultContent": {},
    "ResultContentXML": null,
    "ContentFormat": "TEXT",
    "IsCachedContent": true,
    "DefaultKey": "sample string 7",
    "DivName": "sample string 8",
    "ContentPath": "sample string 9",
    "IsEmptyResult": true,
    "PluginTag": "sample string 11",
    "PluginTagDefault": "sample string 12",
    "ContextName": "sample string 13",
    "SlotName": "sample string 14",
    "VisitorID": "sample string 15",
    "DecisionType": "sample string 16"
  },
  {
    "ContentName": "sample string 1",
    "ResultID": "7962bcd3-04bd-4ed0-ba64-c577459ca256",
    "ContentID": "sample string 3",
    "Result": "sample string 4",
    "ResultContent": {},
    "ResultContentXML": null,
    "ContentFormat": "TEXT",
    "IsCachedContent": true,
    "DefaultKey": "sample string 7",
    "DivName": "sample string 8",
    "ContentPath": "sample string 9",
    "IsEmptyResult": true,
    "PluginTag": "sample string 11",
    "PluginTagDefault": "sample string 12",
    "ContextName": "sample string 13",
    "SlotName": "sample string 14",
    "VisitorID": "sample string 15",
    "DecisionType": "sample string 16"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDecisionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RedPoint.Resonance.Web.Shared">
  <DecisionResult>
    <ContentFormat>TEXT</ContentFormat>
    <ContentID>sample string 3</ContentID>
    <ContentName>sample string 1</ContentName>
    <ContentPath>sample string 9</ContentPath>
    <ContextName>sample string 13</ContextName>
    <DecisionType>sample string 16</DecisionType>
    <DefaultKey>sample string 7</DefaultKey>
    <DivName>sample string 8</DivName>
    <IsCachedContent>true</IsCachedContent>
    <IsEmptyResult>true</IsEmptyResult>
    <PluginTag>sample string 11</PluginTag>
    <PluginTagDefault>sample string 12</PluginTagDefault>
    <Result>sample string 4</Result>
    <ResultContent />
    <ResultContentXML i:nil="true" />
    <ResultID>7962bcd3-04bd-4ed0-ba64-c577459ca256</ResultID>
    <SlotName>sample string 14</SlotName>
    <VisitorID>sample string 15</VisitorID>
  </DecisionResult>
  <DecisionResult>
    <ContentFormat>TEXT</ContentFormat>
    <ContentID>sample string 3</ContentID>
    <ContentName>sample string 1</ContentName>
    <ContentPath>sample string 9</ContentPath>
    <ContextName>sample string 13</ContextName>
    <DecisionType>sample string 16</DecisionType>
    <DefaultKey>sample string 7</DefaultKey>
    <DivName>sample string 8</DivName>
    <IsCachedContent>true</IsCachedContent>
    <IsEmptyResult>true</IsEmptyResult>
    <PluginTag>sample string 11</PluginTag>
    <PluginTagDefault>sample string 12</PluginTagDefault>
    <Result>sample string 4</Result>
    <ResultContent />
    <ResultContentXML i:nil="true" />
    <ResultID>7962bcd3-04bd-4ed0-ba64-c577459ca256</ResultID>
    <SlotName>sample string 14</SlotName>
    <VisitorID>sample string 15</VisitorID>
  </DecisionResult>
</ArrayOfDecisionResult>