OFoffice-of-national-statistics
category-endpoint

findCategories

Changed on

returns the complete list of categories. These can be optionally filtered by role or group. Though the filtering is performed by the application and not the database.

get/categories

Request

  • Base URL
    https://localhost:8171
  • Auth
    none declared

Query parameters

rolestring

role

groupstring

group

Response

OK

groupstring
longDescriptionstring
name'ACTION_CANCELLATION_COMPLETED' | 'ACTION_CANCELLATION_CREATED' | 'ACTION_COMPLETED' | 'ACTION_CREATED' | 'ACTION_UPDATED' | 'ADDRESS_OCCUPIED_NO_RESIDENT' | 'CASE_CREATED' | 'COLLECTION_INSTRUMENT_DOWNLOADED' | 'COLLECTION_INSTRUMENT_ERROR' | 'COMPLETED_BY_PHONE' | 'COMPLY_IN_DIFFERENT_COLLECTION_MODE' | 'DISABLE_RESPONDENT_ENROLMENT' | 'EQ_LAUNCH' | 'GENERATE_ENROLMENT_CODE' | 'LACK_OF_COMPUTER_INTERNET_ACCESS' | 'NO_ACTIVE_ENROLMENTS' | 'NO_LONGER_REQUIRED' | 'OFFLINE_RESPONSE_PROCESSED' | 'ONLINE_QUESTIONNAIRE_RESPONSE' | 'PHYSICALLY_OR_MENTALLY_UNABLE' | 'PRIVACY_DATA_CONFIDENTIALITY_CONCERNS' | 'RESPONDENT_ACCOUNT_CREATED' | 'RESPONDENT_EMAIL_AMENDED' | 'RESPONDENT_ENROLED' | 'SECURE_MESSAGE_SENT' | 'SUCCESSFUL_RESPONSE_UPLOAD' | 'UNSUCCESSFUL_RESPONSE_UPLOAD' | 'VERIFICATION_CODE_SENT'
rolestring
shortDescriptionstring

Changes

  • 803bfe28d21eRevision changes
    • warning

      added the new RESPONDENT_EMAIL_AMENDED enum value to the / response property for the response status

  • 48b735d77a07Revision changes
    • info

      removed the LANGUAGE_DIFFICULTIES enum value from the / response property for the response status

    • info

      removed the NON_RESIDENTIAL_ADDRESS enum value from the / response property for the response status

    • info

      removed the RESPONDENT_EMAIL_AMENDED enum value from the / response property for the response status

    • info

      removed the TOO_BUSY enum value from the / response property for the response status