OFoffice-of-national-statistics
case-endpoint

findCasesBySampleUnitIds

Changed on

find all cases by sample unit id. This also retrieves case events and iac if the relevant parameters are passed to it.

get/cases/sampleunitids

Request

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

Query parameters

sampleUnitIdstring[] required

sampleUnitId

caseeventsboolean

optional flag to indicate if case events should also be return

iacboolean

optional flag to indicate if the iac code should be returned.

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