OFoffice-of-national-statistics
case-endpoint

findCasesBySurveyId

Changed on

retrieve all case groups for a survey and from that all cases related to that case group.

get/cases/surveyid/{surveyId}

Request

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

Path parameters

surveyIdstring required

the uuid of the survey

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