Session Test
Web/Session/{sessionKey}/WebLogins
Updates the login information for a user and logs back into the session using new credentials.



Current and new values must be submitted for login username, password, and email. To retain any of the current values pass the same value for both the current and the new parameter. After successfully updating the user account, the user is automatically logged in with the new login information.



When updating a login where the password has been forgotten, submit the request with a null password.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Session/{sessionKey}/WebLogins

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : WebLoginUpdateRequest

Request object type WebLoginUpdateRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
EmailAddress string Y Current login email address.
FK: T_EADDRESS.address   Resource: ElectronicAddresses
LoginName string Y Current login user name, must be the login used to log into the current session.
FK: T_CUST_LOGIN.login   Resource: WebLogins
LoginTypeId integer Y The type of the login. This determines which login on a constituent account is updated.
FK: TR_LOGIN_TYPE.id   Resource: LoginTypes
NewEmailAddress string Y New email address for the login or existing email if there is no change. Must not be already associated with a login of the same type. If the email does not exist on the constituent's account, it will be added.
NewLoginName string Y New login username.
FK: T_CUST_LOGIN.login   Resource: WebLogins
NewPassword string Y New login password or same password if there is no change.
Password string N Current login password Not required when resetting a temporary password or a login where the password is an empty string.
PromotionCode integer Y The source code to use for the session. Pass 0 to use the default source code.
{
  "LoginName": "sample string 1",
  "NewLoginName": "sample string 2",
  "Password": "sample string 3",
  "NewPassword": "sample string 4",
  "EmailAddress": "sample string 5",
  "NewEmailAddress": "sample string 6",
  "LoginTypeId": 7,
  "PromotionCode": 8
}
<WebLoginUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <EmailAddress>sample string 5</EmailAddress>
  <LoginName>sample string 1</LoginName>
  <LoginTypeId>7</LoginTypeId>
  <NewEmailAddress>sample string 6</NewEmailAddress>
  <NewLoginName>sample string 2</NewLoginName>
  <NewPassword>sample string 4</NewPassword>
  <Password>sample string 3</Password>
  <PromotionCode>8</PromotionCode>
</WebLoginUpdateRequest>

Response object type : Session

Response object type Session has the following properties.
Property Name Data Type Length Required Readonly Notes
BusinessFacing boolean Whether this session is considered to be a business facing session (only used by TRBO).
CartInfo CartInfo Contains a count of each cart product for the session. Also, the date/time of the first seat added to the cart is returned.
CheckoutStatus CheckoutStatus
HasLockedSeats boolean
IsGuest boolean If true, this session is using general public for checkout. Any contact details will be associated to the order but stored as constituent id 0.
IsLoggedIn boolean True if the session has been logged in.
LoginInfo SessionLoginInfo Summary data (constituent, email, etc) pertaining to the active login for the session.
ModeOfSaleId integer The current mode of sale for the session and cart. This can differ from the OriginalModeOfSale if a promotion shifts the session to a different mode of sale or the mode of sale has been updated on the cart.
OrderId integer
OriginalModeOfSaleId integer The default mode of sale for the session when initiated.
SeatsExpired boolean If true, seats that have been previously locked have expired and are no longer locked.
SourceId integer The current source applied to the order and products as they are added to the cart.
{
  "OrderId": 1,
  "IsLoggedIn": true,
  "ModeOfSaleId": 3,
  "OriginalModeOfSaleId": 4,
  "SourceId": 5,
  "LoginInfo": {
    "ConstituentId": 1,
    "OriginalConstituentId": 2,
    "UserId": "sample string 3",
    "Status": "sample string 4",
    "FailedAttempts": 5,
    "LockedDate": "2025-04-24T04:11:37.9051122-07:00",
    "ElectronicAddress": "sample string 6"
  },
  "CartInfo": {
    "PerformanceCount": 1,
    "PackageCount": 2,
    "ContributionCount": 3,
    "MembershipCount": 4,
    "UserDefinedFeeCount": 5,
    "GiftCertificateCount": 6,
    "PaymentCount": 7,
    "FirstSeatAddedDateTime": "2025-04-24T04:11:37.9051122-07:00"
  },
  "BusinessFacing": true,
  "IsGuest": true,
  "CheckoutStatus": {
    "Status": "sample string 1",
    "Date": "2025-04-24T04:11:37.9051122-07:00"
  },
  "HasLockedSeats": true,
  "SeatsExpired": true
}
<Session xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BusinessFacing>true</BusinessFacing>
  <CartInfo>
    <ContributionCount>3</ContributionCount>
    <FirstSeatAddedDateTime>2025-04-24T04:11:37.9051122-07:00</FirstSeatAddedDateTime>
    <GiftCertificateCount>6</GiftCertificateCount>
    <MembershipCount>4</MembershipCount>
    <PackageCount>2</PackageCount>
    <PaymentCount>7</PaymentCount>
    <PerformanceCount>1</PerformanceCount>
    <UserDefinedFeeCount>5</UserDefinedFeeCount>
  </CartInfo>
  <CheckoutStatus>
    <Date>2025-04-24T04:11:37.9051122-07:00</Date>
    <Status>sample string 1</Status>
  </CheckoutStatus>
  <HasLockedSeats>true</HasLockedSeats>
  <IsGuest>true</IsGuest>
  <IsLoggedIn>true</IsLoggedIn>
  <LoginInfo>
    <ConstituentId>1</ConstituentId>
    <ElectronicAddress>sample string 6</ElectronicAddress>
    <FailedAttempts>5</FailedAttempts>
    <LockedDate>2025-04-24T04:11:37.9051122-07:00</LockedDate>
    <OriginalConstituentId>2</OriginalConstituentId>
    <Status>sample string 4</Status>
    <UserId>sample string 3</UserId>
  </LoginInfo>
  <ModeOfSaleId>3</ModeOfSaleId>
  <OrderId>1</OrderId>
  <OriginalModeOfSaleId>4</OriginalModeOfSaleId>
  <SeatsExpired>true</SeatsExpired>
  <SourceId>5</SourceId>
</Session>
Change Version Description Contract Old New
Property Added 15.1.7 HasLockedSeats has been added to Session Session Session.HasLockedSeats
Property Added 15.1.7 SeatsExpired has been added to Session Session Session.SeatsExpired
Property Added 15.0.0 CheckoutStatus has been added to Session Session Session.CheckoutStatus
Parameter Changed 15.0.0 sessionKey has been marked as required. Required