v12

latestOpenAPI 3.0.1raw.githubusercontent.com2025-11-0520827.9 KB

category-endpoint

findCategories

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

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