API Output Response fields

Table 209. API Output Response Fields
Field Name Field Description
OUT-TOTAL-RECS

This field is used only with Multiple record retrieval.

This contains the total number of records retrieved by the HTTP GET request.

The value for this field can be mapped to an HTTP Header field as a response to the HTTP GET request

OUT-RECS-THIS-CALL

This field is used only with Multiple record retrieval.

This contains the number of records returned by the current API call, not the total records retrieved by the HTTP GET request. The total number of records retrieved by the API can be filtered using the IN-OFFSET and IN-LIMIT fields.

This field is used as a COUNTED BY field to limit the array size of the API response.

OUT-REC-SIZE

This contains the size of the input data layout received by the API interface.

OUT-ERROR-CODE

This contains the EIBRESP response code if any of the CICS command API calls failed or if a TB-ERROR-CODE if tableBASE API call failed.

This field can be used to
diagnose the error condition. All tableBASE error codes and
their description can be found in tableBASE Programming Guide Appendix E, tableBASE Error Codes.

OUT-ERROR-SUB-CODE

This contains the EIBRESP2 response code if any of the CICS command API calls failed or if a TB-ERROR-SUB-CODE if tableBASE API call failed.

This field can be used to
diagnose the error condition. All tableBASE error sub codes
and their description can be found in tableBASE Programming Guide Appendix E, tableBASE Error Codes.

OUT-RESPONSE-MESSAGE This field can be used to diagnose the error condition.
OUT-FILLER

This field is available for future enhancements.