OFoffice-of-national-statistics
case-endpoint

findCasesByPartyId

Changed on

find cases that have the requested party id

get/cases/partyid/{partyId}

Request

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

Path parameters

partyIdstring required

partyId

Query parameters

caseeventsboolean

caseevents

iacboolean

iac

max_cases_per_surveyinteger

The maximum number of cases to return per survey. Note this filtering happens in the application and not at the db level.

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