All server responses (except those resulting in an HTTP 500 error) will provide a metadata record in the form of a hash (JSON) or element (XML) containing various metadata parameters. A list of errors resulting from a client request that returns a non-successful (non-200) status code.
Parameters
| Parameter | Description |
|---|---|
| errorcount | An integer representing the number of errors provided in the errorList. If an errorCount is defined as nonzero, the errorList should be examined for more information. |
| errorList | A list of hashes (JSON) or elements (XML) containing error information. At a minimum, error records in this list will contain a message key/element with a human readable message describing the error. |
| idField | (List Responses Only) Identifies the parameter name of the uniquely identifying parameter for the list records. |
| maxId | (List Responses Only) The maximum id returned by the list results. The associated id column will be identified by the idField parameter. |
| minId | (List Responses Only) The minimum id returned by the list results. The associated id column will be identified by the idField parameter. |
| more | (List Responses Only) 0 or 1: Indicates whether more results exist beyond those returned with the record list. If more records exist, this indicates that modifying your search terms by specifying different boundary parameters (e.g., minId or maxId) will result in returning these additional records |
| recordCount | (List Responses Only) An integer representing the number of result records returned in the associated list response. |
| sort | (List Responses Only) Identifies the sorting parameter and method for the resulting list records. |