Class GetSettingsResponse

Contains the results from a GetSettingsRequest.

---

Properties

NAME	TYPE	DESCRIPTION
RequestId	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	string	Can be Error or Resource code depending on type of result.
ResultMessage	string	Message regarding details of the Result.
ValidationResults	ValidationResult[]	Array of ValidationResult objects containing messages regarding input validation.
Credentials	TokenCredentials	Credentials for subsequent web service requests.
AllowCreateCustomer	bool	A setting allowing the user to create a customer, if Merchant Customer.Create permission has been granted.
AllowSaveUsername	bool	A setting to allow the application to save the username.
AllowUpdateCustomer	bool	A setting allowing the user to update a customer, if Merchant Customer.Edit permission has been granted.
EnablePasswordChange	bool	A setting to allow the user to change their password.
GeoLocationAccess	GeoLocationAccess	DEPRECATED. This property is no longer used.
MiSnapLicense	string	A setting containing the MiSnap license key.
ShowCustomBatchId	bool	A setting to show custom batch id's.
ShowDataEntry	bool	A setting to show the data entry fields.
MiSnapLicenseIntegrator	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": "f89ur93iu983uj98ru923",
    "Result": 1,
    "ResultCode": null,
    "ResultMessage": null,
    "ValidationResults": [],
    "Credentials": {
        "PhoneKey": "1",
        "SecurityToken": "String Content"
    },
    "AllowCreateCustomer": true,
    "AllowSaveUsername": true,
    "AllowUpdateCustomer": true,
    "EnablePasswordChange": true,
    "GeoLocationAccess": 0,
    "ShowCustomBatchId": false,
    "ShowDataEntry": true,
    "MiSnapLicense": null,
    "MiSnapLicenseIntegrator": null
}

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