Skip to main content

Class UpdateBatchResponse

This method is used to make changes to batch details.


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.
BatchBatchThe updated batch details.

Batch

NAMETYPEDESCRIPTION
BatchNumberstringA unique number either assigned by the user to correlate to the integrators system or autogenerated by the system. Also known as Deposit Name.
BatchReferencestringThe unique value assigned to each batch which can be used to find details about the batch.
EventsEvent[]Events that have occured on the batch.
LocationNamestringThe location used for the deposit.
LocationReferencestringThe unique value of the location used for the deposit.
StatusstringThe Batch status code.
StatusDescriptionstringThe Batch status description to be displayed.
TotalAmountdecimalThe amount of the items in a batch in DECIMAL format.
TotalCountdecimalThe number of items in the batch.

Examples

{
"__type": "UpdateBatchResponse:#JackHenry.Eps.Mobile.RDC",
"Batch": {
"__type": "Batch:#JackHenry.Eps.Mobile.RDC",
"LocationName": "String Content",
"LocationReference": "String Content",
"BatchReference": "String Content",
"BatchNumber": "String Content",
"Status": "String Content",
"StatusDescription": "String Content",
"TotalAmount": 12678967.54,
"TotalCount": 12678967.54,
"Events": []
}
}

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