OFoffice-of-national-statistics
case-endpoint

createCaseEvent

Changed on

creates a case event

post/cases/{caseId}/events

Request

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

Path parameters

caseIdstring required

caseId

Request body

category'ACCESS_CODE_AUTHENTICATION_ATTEMPT' | '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' required
createdBystring required
descriptionstring required
subCategorystring
metadataobject

Response

OK

caseIdstring
category'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'
createdBystring
createdDateTimestring date-time
descriptionstring
metadataobject
partyIdstring
subCategorystring

Changes

  • 803bfe28d21eRevision changes
    • warning

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

    • info

      added the new RESPONDENT_EMAIL_AMENDED enum value to the request property

  • 48b735d77a07Revision changes
    • breaking

      removed the enum value LANGUAGE_DIFFICULTIES of the request property

    • breaking

      removed the enum value NON_RESIDENTIAL_ADDRESS of the request property

    • breaking

      removed the enum value RESPONDENT_EMAIL_AMENDED of the request property

    • breaking

      removed the enum value TOO_BUSY of the request property

    • 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