Class CreateBatchResponse

Results from a CreateBatchRequest.

---

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.
Batch	Batch	Batch information that was created.

Batch

NAME	TYPE	DESCRIPTION
BatchNumber	string	A unique number either assigned by the user to correlate to the integrators system or autogenerated by the system. Also known as Deposit Name.
BatchReference	string	The unique value assigned to each batch which can be used to find details about the batch.
Events	Event[]	Events that have occured on the batch.
LocationName	string	The location used for the deposit.
LocationReference	string	The unique value of the location used for the deposit.
Status	string	The Batch status code.
StatusDescription	string	The Batch status description to be displayed.
TotalAmount	decimal	The amount of the items in a batch in DECIMAL format.
TotalCount	decimal	The number of items in the batch.

Examples

{
  "__type": "CreateBatchResponse:#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

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