Session Test
Web/Session/{sessionKey}/Login/SendCredentials
Sends an email with a temporary login token to a specific email address and login type.

The service searches for the email address in logins of the specified type. If it is found, a password token will be generated and the login credentials template that is configured in T_FORMAT_INFO will be sent.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Session/{sessionKey}/Login/SendCredentials

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : SendCredentialsRequest

Request object type SendCredentialsRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
EmailAddress string Y Email address to search for.
LoginTypeId integer Y Login type to search for the email address with in.
FK: TR_LOGIN_TYPE.id   Resource: LoginTypes
TemplateFormatId integer The row in /ReferenceData/Formats that is the Credential Email to use to determine the HTML Template to use. If not supplied the system default “CRED_EMAIL_FORMAT_NO” will be used. 
{
  "EmailAddress": "sample string 1",
  "LoginTypeId": 2,
  "TemplateFormatId": 1
}
<SendCredentialsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <EmailAddress>sample string 1</EmailAddress>
  <LoginTypeId>2</LoginTypeId>
  <TemplateFormatId>1</TemplateFormatId>
</SendCredentialsRequest>

Response object type : SessionWebLogin

Response object type SessionWebLogin has the following properties.
Property Name Data Type Length Required Readonly Notes
Constituent Entity Y
ConstituentUpdateDate date N
CreatedBy string N Auto-assigned
CreatedDateTime date N Auto-assigned
CreateLocation string N Auto-assigned
EditIndicator boolean
Email Entity N
FK: T_EADDRESS.eaddress_no   Resource: ElectronicAddresses
FailedAttempts integer Y
Id integer N Auto-assigned
Inactive boolean Y
LastLoginDate date N
LockedDate date N
Login string 80 N Required only if LoginType.LoginWithEmail is "N".
LoginType LoginTypeSummary Y
FK: TR_LOGIN_TYPE.id   Resource: LoginTypes
Password string 40 Y Required for POST
PrimaryIndicator boolean Y Defaults to false.
TemporaryIndicator boolean Y Defaults to true.
UpdatedBy string N Auto-assigned
UpdatedDateTime date N Auto-assigned 
{
  "ConstituentUpdateDate": "2025-04-24T04:03:00.214449-07:00",
  "CreatedDateTime": "2025-04-24T04:03:00.214449-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Constituent": {
    "Id": 1
  },
  "Email": {
    "Id": 1
  },
  "FailedAttempts": 3,
  "Inactive": true,
  "LastLoginDate": "2025-04-24T04:03:00.214449-07:00",
  "UpdatedDateTime": "2025-04-24T04:03:00.214449-07:00",
  "UpdatedBy": "sample string 4",
  "LockedDate": "2025-04-24T04:03:00.214449-07:00",
  "Login": "sample string 5",
  "Password": "sample string 6",
  "Id": 1,
  "LoginType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "PrimaryIndicator": true,
  "TemporaryIndicator": true,
  "EditIndicator": true
}
<SessionWebLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <ConstituentUpdateDate>2025-04-24T04:03:00.214449-07:00</ConstituentUpdateDate>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T04:03:00.214449-07:00</CreatedDateTime>
  <EditIndicator>true</EditIndicator>
  <Email>
    <Id>1</Id>
  </Email>
  <FailedAttempts>3</FailedAttempts>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <LastLoginDate>2025-04-24T04:03:00.214449-07:00</LastLoginDate>
  <LockedDate>2025-04-24T04:03:00.214449-07:00</LockedDate>
  <Login>sample string 5</Login>
  <LoginType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </LoginType>
  <Password>sample string 6</Password>
  <PrimaryIndicator>true</PrimaryIndicator>
  <TemporaryIndicator>true</TemporaryIndicator>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:03:00.214449-07:00</UpdatedDateTime>
</SessionWebLogin>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required
Property Added 15.0.0 TemplateFormatId has been added to SendCredentialsRequest SendCredentialsRequest SendCredentialsRequest.TemplateFormatId