ResponseCode Property

Indicates the status of the close batch request.

Syntax

 tsyshcbatchmgr.getResponseCode([callback])

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getResponseCode([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setResponseCode([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Indicates the status of the close batch request.

This property contains the response code indicating the status of a batch management request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents a successful request. All other response codes represent non-approved requests.


Response Code	Response Text	Definition
00	"ACCEPTED" or "DATA RETRIEVED"	If CloseBatch is called response text will be "ACCEPTED", otherwise it will be "DATA RETRIEVED".
01	"EXCEEDED LIMIT"	The requested batch or transaction was not in the allowable limits (current, previous, or last 5 batches).
02	"COULD NOT FIND"	The host system could not find the batch or the transaction that was requested.
03	"NOT ALLOWED"	An invalid request was entered.
04	"SYSTEM ERROR"	The host system was not able to process the request due to some internal issue, maintenance, or other system error.
05	"ALREADY CLOSED"	During a batch close request, the batch was already found to have been closed. A batch summary will be provided with the pertinent information.
06	"NOT IN BATCH"	The requested Adjustment or Void was not in the current batch.

This property is read-only.

Data Type

String