ExtendedResponseInterface

Get API response code

Get API response description

Get Request URL

Get Plain API response

Get API response as Hash

Check if current API response represents an error case (a 5xx code)

Check if current API response represents a success case (a 2xx code)

Get column by column name, or null if the column does not exist

Get Data by Column Name and Index, or null if not found

Get Column Names — the response's data columns, in wire order.

Never includes the brand's response metadata (CNR: TOTAL, FIRST, LAST, COUNT, LIMIT; IBS: transactid, status, message, code, the total_ prefixed keys and domaincount). Those are not columns at all since RSRMID-2965 — read them through {\CNIC\self::getPagination()} and the status accessors instead of {\CNIC\self::getColumn()}/{@see \CNIC\self::getColumnIndex()}. The former getColumnKeys(true) that stripped them is gone: with the column set correct there is nothing left to strip.

Get List of Columns

Get Command used in this request

Get Command used in this request in plain text format

Get context data for the response

Get Index of first row in this response — the offset the current window starts at, or null when the response carries no pagination metadata (a non-list response).

A pure read of the brand's own wire metadata since RSRMID-2965: it no longer falls back to 0 because rows happen to be present, so "this is page 1" and "this is not a list" are distinguishable answers.

Get last record index of the current list query, or null when the response carries no pagination metadata (a non-list response).

Also a pure wire read since RSRMID-2965 — no getRecordsCount() - 1 fallback. Note it is an offset into the whole result set, not an index into {\CNIC\self::getRecords()}: the window FIRST=100, LIMIT=10 answers 109 here, while its last row is getRecord(9). The two coincide on the first page only.

Get the paginator for this response's list window.

Everything derived from the four primitives above — page numbers, the page count and the has-next/has-previous predicates — is answered by {\CNIC\Paginator} rather than by this interface (RSRMID-2965). It reads no wire payload, so pagination arithmetic can be exercised without one, and a caller who never pages is not carrying six methods for it.

The former array is getPagination()->toArray(), unchanged in keys and order.

Get Record at given index, or null if the index does not exist

Get all Records

Iterate the record list, keyed by record index.

Redeclared here — {\IteratorAggregate} already requires it — so the element type is stated on the contract consumers type against, rather than only where it happens to be implemented. foreach is the supported way to walk the rows: it holds its position in the loop rather than on the response, so nothing a caller does while iterating is visible to another holder of the same response, and a second foreach starts from the top with no rewind step. See the class docblock for what this replaced.

Get count of rows in this response

Get total count of records available for the list query, or null when the response carries no TOTAL metadata (a non-list response)

Get limit(ation) setting of the current list query — the count of requested rows — or null when the response carries no LIMIT metadata.

0 is a distinct, meaningful value (LIMIT=0 was requested); it no longer collides with "absent"

Get Queuetime of API response

Get Runtime of API response

Check if current API response represents a temporary error case (a 4xx code)

Check if current operation is returned as pending

Get Response as List Hash including useful meta data for tables