Name 

Description 

 

StatusCodes 

Constants for TAuthenticate.Status 

 

Name 

Description 

 

GetUserId 

 

 

IsOk 

Returns true if the status is OK, false if not 

 

Name 

Description 

 

HasExplicitAccess 

 

 

StatusEnum 

Represents the status as an enumeration, for internal use The status is exposed to the web service as an int 

 

Name 

Description 

 

BadId 

TAuthenticate.Id - if there is no ID 

 

BadIdentifier 

TAuthenticate.Identifier - if there is no identifier 

 

TokenTypeClient 

TAuthenticate.TokenType for a Client login token 

 

TokenTypeStaff 

TAuthenticate.TokenType for a Staff login token 

 

Name 

Description 

 

TAuthenticate 

This is the overview for the TAuthenticate constructor overload. 

 

ToString 

Constructs a string of this object 

 

Name 

Description 

 

ID 

ID of the User who generated the Token.
If an authentication is unsuccessful, the Identifier property is set to BAD_ID = '-1'. 

 

Identifier 

A Identifier of the User who generated the Token.
In the case of a Client, the Identifier is the Client's Clie_Code property. For an Employer, it is the Employer's Empl_Identifier property.
If an authentication is unsuccessful, the Identifier property is set to BAD_IDENTIFIER = '-1'. 

 

Status 

An Integer Status, which can take the following values:

• STATUS_MISSING_REGISTRATION = -5: The registration key does not contain a valid entry required for the called function
• STATUS_NO_RECORDS = -4: No records found. Often occurs because the requested record does not exist
• STATUS_DB_ERROR = -3: Serious database error occurred
• STATUS_EXPIRED = -2: Supplied token has expired. Tokens expire after 60 minutes of no use
• STATUS_ERROR = -1: Error has occurred (such as invalid input)
• STATUS_UNKNOWN = 0: Indeterminable problem has occurred
• STATUS_OK = 1: Success

 

 

StatusMessage 

A Status Message, usually used when a problem occurs. 

 

Token 

A token which must be valid to access non public domain data from the database. An empty string ('') is usually returned as the Token if the is a problem executing a function which requires a Token.
A valid token contains information about the user who created it:

• Identifier,
• Token Type.

Both a Staff and Student user have type CLIE_TOKEN embedded in the token. This arises because they both come from the Client table. 

 

TokenType 

Type of Token.
This depends on who generated the Token. Valid Types are:

• CLIE_TOKEN = '02' if generated by a Client (Student, Employee, ...),
• STAF_TOKEN = '03' if generated by a Client who is a Staff Member.

Note a token only uses CLIE_TOKEN. However, some function may flag STAF_TOKEN for Clients who are Staff Members.