OFoffice-of-national-statistics
case-endpoint

findCaseById

Changed on

find a case and it's case events by an id.

get/cases/{caseId}

Request

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

Path parameters

caseIdstring required

the case event

Query parameters

caseeventsboolean

optional flag to return case events if required.

iacboolean

iac

Response

OK

actionPlanIdstring
caseRefstring
collectionInstrumentIdstring
createdBystring
createdDateTimestring date-time
iacstring
idstring
partyIdstring
sampleUnitIdstring
sampleUnitTypestring
state'ACTIONABLE' | 'INACTIONABLE' | 'REPLACEMENT_INIT' | 'SAMPLED_INIT'

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