Class GetSettingsResponse

Contains the results from a GetSettingsRequest.

---

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.
AllowSaveUsername	System.Boolean	A setting to allow the application to save the username.
EnablePasswordChange	System.Boolean	A setting to allow the user to change their password.
GeoLocationAccess	GeoLocationAccess	Deprecated. This setting is no longer used.
ShowCustomBatchId	System.Boolean	A setting that indicates whether the Financial Institution is configured to allow a user to enter their own custom batch id's. This correlates to the BatchNumber in the Batch Class. If false, then BatchNumber is not required and EPS will generate one. If true, then the field is required.
MiSnapLicenseIntegrator	System.string	A setting containing the Integrator MiSnap License Key

GeoLocationAccess

NAME	TYPE	DESCRIPTION
Disabled	0	Disabled
Required	1	Required
CaptureIfAvailable	2	Capture if available

Examples

{
    "RequestId": "123456789",
    "Result": 1,
    "ResultCode": null,
    "ResultMessage": null,
    "ValidationResults": [],
    "Credentials": {
        "SecurityToken": "String Content"
    },
    "AllowSaveUsername": true,
    "EnablePasswordChange": true,
    "GeoLocationAccess": 0,
    "MiSnapLicenseIntegrator": null,
    "ShowCustomBatchId": false
}

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