Session Test
Web/Session
Creates a new session and returns a unique session key.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Session

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : SessionRequest

Request object type SessionRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
BusinessUnitId integer N The business unit for this session.
FK: TR_BU.id   Resource: BusinessUnits
IpAddress string N Specifies the IP Address to be stored in the T_WEB_SESSION_SESSION table. Defaults to empty string if not provided.
Organization string N The organization name for this session. Must match the description column for a row in TR_ORGANIZATION. Default is IMPRESARIO if not provided.
PromotionCode integer N A promotion code (source number) to apply to the created session. If not supplied the default promotion code (source number) will be applied.
FK: TX_APPEAL_MEDIA_TYPE.source_no   Resource: Sources 
{
  "IpAddress": "sample string 1",
  "BusinessUnitId": 2,
  "Organization": "sample string 3",
  "PromotionCode": 4
}
<SessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BusinessUnitId>2</BusinessUnitId>
  <IpAddress>sample string 1</IpAddress>
  <Organization>sample string 3</Organization>
  <PromotionCode>4</PromotionCode>
</SessionRequest>

Response object type : SessionResponse

Response object type SessionResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
SessionKey string 
{
  "SessionKey": "sample string 1"
}
<SessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SessionKey>sample string 1</SessionKey>
</SessionResponse>
Change Version Description Contract Old New
Property Added 15.0.0 PromotionCode has been added to SessionRequest SessionRequest SessionRequest.PromotionCode