Skip to main content

Class AuthenticateResponse

Results from a AuthenticateRequest.


Properties

NAMETYPEDESCRIPTION
RequestIdSystem.stringUnique identifier used to identify the request associated with the response.
ResultResponseResultTypeValue indicating type of result. Possible values: Error (default), Success, ValidationError, NoChange
ResultCodeSystem.stringCan be Error or Resource code depending on type of result.
ResultMessageSystem.stringMessage regarding details of the Result.
ValidationResultsValidationResult[]Array of ValidationResult objects containing messages regarding input validation.
Credentials TokenCredentials A security token representing an authenticated user which will be used in subsequent calls. The token expires after 20 minutes.
PromptTermsAndConditionsSystem.BooleanIndicates if a user needs to be prompted for the terms and conditions.

Examples

{
"__type": "AuthenticateResponse:#JackHenry.Eps.Mobile.RDA",
"PromptTermsAndConditions": true
}

Methods

Exception(string)

Declaration

public void Exception(string message)

Parameters

TYPENAMEDESCRIPTION
System.Stringmessage

NullRequestResonse()

Declaration

public static Response NullRequestResonse()

Return Value

TYPEDESCRIPTION
Response

Success()

Declaration

public void Success()

Success(String)

Declaration

public void Success(string resultMessage)

Parameters

TYPENAMEDESCRIPTION
System.StringresultMessage