OFoffice-of-national-statistics
legacy

Http Get Ci Metadata V2

Changed on

GET method that returns any metadata objects from CIR that match the parameters passed. The user has multiple ways of querying the metadata.

  1. Provide survey_id, classifiers, language.
  2. Provide no parameters. This endpoint is deprecated.
get/v2/ci_metadata

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

classifier_type'form_type' | 'default'

classifier_type used by the CI

classifier_valuestring

classifier_value used by the CI

languagestring

The language of the CI

survey_idstring

The survey_id of the CI

Response

Successful Response

unknown required

Changes

  • e82a1a49216cRevision changes
    • breaking

      removed the enum value default from the query request parameter classifier_type

    • breaking

      removed the enum value form_type from the query request parameter classifier_type

    • info

      for the query request parameter classifier_type, the type was generalized from string to no type

  • 1e0c2422ae94Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status