Skip to main content

Class GetLocationsResponse

Results of a GetLocationsRequest.


Properties

NAMETYPEDESCRIPTION
RequestIdstringUnique identifier used to identify the request associated with the response.
ResultResponseResultTypeValue indicating type of result. Possible values: Error (default), Success, ValidationError, NoChange
ResultCodestringCan be Error or Resource code depending on type of result.
ResultMessagestringMessage regarding details of the Result.
ValidationResultsValidationResult[]Array of ValidationResult objects containing messages regarding input validation.
CredentialsTokenCredentialsCredentials for subsequent web service requests.
LocationsLocation[]The list of locations found.

Location

NAMETYPEDESCRIPTION
IsEnabledboolIndicates whether the Locations is enabled or not.
LocationNumberstringA unique custom value that correlates to the FI.
LocationReferencestringThis is the unique identifier assigned to the location for use in requests/responses in the mRDC API. This identifier is generated and used by the mRDC API and is different from the Location ID.
NamestringThe Location name.

Examples

{
"__type": "GetLocationsResponse:#JackHenry.Eps.Mobile.RDC",
"Locations": [
{
"__type": "Location:#JackHenry.Eps.Mobile.RDC",
"LocationReference": "String Content",
"Name": "String Content",
"IsEnabled": true,
"LocationNumber": "String Content"
}
]
}

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