Class AuthenticatedResponse
All Responses will derive from this class
Properties
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| RequestId | System.string | Unique identifier used to identify the request associated with the response. |
| Result | ResponseResultType | Value indicating type of result. Possible values: Error (default), Success, ValidationError, NoChange |
| ResultCode | System.string | Can be Error or Resource code depending on type of result. |
| ResultMessage | System.string | Message regarding details of the Result. |
| ValidationResults | ValidationResult[] | 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. |
TokenCredentials
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| SecurityToken | System.String | REQUIRED. A security token representing an authenticated user which will be used in subsequent calls. The token expires after 20 minutes. Subsequent calls with a token will respond with a new token that should be used to replace the old token, however a new token will not invalidate the old token and will still remain active for 20 minutes. |
Examples
{
"__type": "AuthenticatedResponse:#JackHenry.Eps.Mobile.RDA",
"Credentials": {
"__type": "TokenCredentials:#JackHenry.Eps.Mobile.RDA",
"SecurityToken": "String Content"
}
}
Methods
Exception(string)
Declaration
public void Exception(string message)
Parameters
| TYPE | NAME | DESCRIPTION |
|---|---|---|
| System.String | message |
NullRequestResonse()
Declaration
public static Response NullRequestResonse()
Return Value
| TYPE | DESCRIPTION |
|---|---|
| Response |
Success()
Declaration
public void Success()
Success(String)
Declaration
public void Success(string resultMessage)
Parameters
| TYPE | NAME | DESCRIPTION |
|---|---|---|
| System.String | resultMessage |