Session Test
Web/Session/{sessionKey}/Constituents
Sets the current constituent on the cart for a business facing session

If the Constituent is a primary affiliate of a household, the method obeys the "TRANSACT_AS_HOUSEHOLD_ORDER" entry in T_DEFAULTS to determine if the household constituent should be set.

If the default is set to "Prompt", both the household and individual are returned, to allow the user to be queried. To set the constituent to the users choice pass in the selected constituent id and set OverridePrompt to true.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Session/{sessionKey}/Constituents

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : SetConstituentRequest

Request object type SetConstituentRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
ConstituentId integer Y The Id of the constituent to set for the cart.
FK: T_CUSTOMER.customer_no   Resource: Constituents
OverridePrompt boolean Used to set a specific constituent when the TRANSACT_AS_HOUSEHOLD_ORDER entry in T_DEFAULTS is set to "Prompt". 
{
  "ConstituentId": 1,
  "OverridePrompt": true
}
<SetConstituentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ConstituentId>1</ConstituentId>
  <OverridePrompt>true</OverridePrompt>
</SetConstituentRequest>

Response object type : Collection of WebConstituentDisplaySummary

Response object type Collection of WebConstituentDisplaySummary has the following properties.
Property Name Data Type Length Required Readonly Notes
DisplayName string
Id integer 
[
  {
    "Id": 1,
    "DisplayName": "sample string 1"
  },
  {
    "Id": 1,
    "DisplayName": "sample string 1"
  }
]
<WebConstituentDisplaySummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <WebConstituentDisplaySummary>
    <DisplayName>sample string 1</DisplayName>
    <Id>1</Id>
  </WebConstituentDisplaySummary>
  <WebConstituentDisplaySummary>
    <DisplayName>sample string 1</DisplayName>
    <Id>1</Id>
  </WebConstituentDisplaySummary>
</WebConstituentDisplaySummaries>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required