OFoffice-of-national-statistics
Code List

Get a list of all codes within a code list edition

Get a list of codes within a code list edition

get/code-lists/{id}/editions/{edition}/codes

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • Auth
    none declared

Path parameters

idstring required

The ID of a code list

editionstring required

The edition of the code list

Query parameters

limitinteger

Maximum number of items that will be returned. A value of zero will return zero items. The default value is 20 and the maximum allowed is 1000.

offsetinteger

Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning.

Response

A Json message containing a list of Codes

countstring

The number of results returned in this response

total_countstring

The total number of results available

limitstring

The limit applied to the number of results returned

offsetstring

The offset applied to the number of results returned

Changes

No recorded changes to this operation across all 1 revision of this API.