Session Test
Web/Session/{sessionKey}/PromoCode
Returns promotion information for a session by number or description

A primary use of this method is to translate promo codes (text) into source codes (integers). This method also returns the 6 fields of text that can be recorded for each web source, which can be used to display specific messaging when a promo code is entered by a constituent.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Session/{sessionKey}/PromoCode

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : WebPromoCodeRequest

Request object type WebPromoCodeRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
PromoCode integer The numeric promo code (source) to return. Either the PromoCodeString or the PromoCode is required.
PromoCodeString string The text promo code to return. Either the PromoCodeString or the PromoCode is required. 
{
  "PromoCodeString": "sample string 1",
  "PromoCode": 1
}
<WebPromoCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PromoCode>1</PromoCode>
  <PromoCodeString>sample string 1</PromoCodeString>
</WebPromoCodeRequest>

Response object type : Collection of WebPromoCode

Response object type Collection of WebPromoCode has the following properties.
Property Name Data Type Length Required Readonly Notes
ModeOfSaleId integer The new Mode of Sale that will be applied to the session if this source is used.
OverrideRankIndicator string Indicates that this source's MOS change should override any rank-based MOS change.
PromoCode string The Text promo code for the source.
PromotionDate date The date that this source code was promoted to the constituent's record, if any.
Source SourceSummary The numeric source and description.
Text1 string
Text2 string
Text3 string
Text4 string
Text5 string
Text6 string 
[
  {
    "ModeOfSaleId": 1,
    "OverrideRankIndicator": "sample string 2",
    "PromoCode": "sample string 3",
    "PromotionDate": "2025-04-24T03:56:25.2327961-07:00",
    "Source": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true,
      "Appeal": {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      }
    },
    "Text1": "sample string 4",
    "Text2": "sample string 5",
    "Text3": "sample string 6",
    "Text4": "sample string 7",
    "Text5": "sample string 8",
    "Text6": "sample string 9"
  },
  {
    "ModeOfSaleId": 1,
    "OverrideRankIndicator": "sample string 2",
    "PromoCode": "sample string 3",
    "PromotionDate": "2025-04-24T03:56:25.2327961-07:00",
    "Source": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true,
      "Appeal": {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      }
    },
    "Text1": "sample string 4",
    "Text2": "sample string 5",
    "Text3": "sample string 6",
    "Text4": "sample string 7",
    "Text5": "sample string 8",
    "Text6": "sample string 9"
  }
]
<WebPromoCodes xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <WebPromoCode>
    <ModeOfSaleId>1</ModeOfSaleId>
    <OverrideRankIndicator>sample string 2</OverrideRankIndicator>
    <PromoCode>sample string 3</PromoCode>
    <PromotionDate>2025-04-24T03:56:25.2327961-07:00</PromotionDate>
    <Source>
      <Appeal>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </Appeal>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Source>
    <Text1>sample string 4</Text1>
    <Text2>sample string 5</Text2>
    <Text3>sample string 6</Text3>
    <Text4>sample string 7</Text4>
    <Text5>sample string 8</Text5>
    <Text6>sample string 9</Text6>
  </WebPromoCode>
  <WebPromoCode>
    <ModeOfSaleId>1</ModeOfSaleId>
    <OverrideRankIndicator>sample string 2</OverrideRankIndicator>
    <PromoCode>sample string 3</PromoCode>
    <PromotionDate>2025-04-24T03:56:25.2327961-07:00</PromotionDate>
    <Source>
      <Appeal>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </Appeal>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Source>
    <Text1>sample string 4</Text1>
    <Text2>sample string 5</Text2>
    <Text3>sample string 6</Text3>
    <Text4>sample string 7</Text4>
    <Text5>sample string 8</Text5>
    <Text6>sample string 9</Text6>
  </WebPromoCode>
</WebPromoCodes>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required