/

OFoffice-of-national-statistics

Docs
History
Schema
Generate

Retired

Filter operations

businesses11

enrolments1

info1

misc11

respondents29

get/respondents/emailGet a respondent by email
put/respondents/emailChange the email address of a respondent
delete/respondents/{email}Mark a respondent for deletion by email
get/tokens/verify/{token}Verify a token
put/respondents/change_passwordChange the password of a respondent
put/respondents/reset_passwordChange respondent password using one-time token
post/respondents/request_password_changeRequest a password change email
get/respondentsGet a respondent by query parameters
post/respondentsCreate a respondent
put/emailverification/{token}Verify an email address
post/resend-verification-email/{party-uuid}Resend the verification email
post/resend-account-email-change-notification/{party_uuid}Resend the email change notification email
post/resend-account-email-change-expired-token/{token}Resend the "expired token" email for change email
post/resend-verification-email-expired-token/{token}Resend the "expired token" email for verification email
post/resend-password-email-expired-token/{token}Resend the "expired token" email for password change
post/respondents/add_surveyEnrol a respondent on a new survey
put/respondents/change_enrolment_statusChange the enrolment status of a respondent
patch/respondents/disable-user-enrolmentsDisable all enrolments for a respondent
get/respondents/id/{id}Get a respondent by ID
put/respondents/id/{id}Update a respondent's details
get/respondents/party_id/{party_id}Get a respondent by party_id
get/respondents/survey_id/{survey_id}/business_id/{business_id}Get respondents by survey and business
get/respondents/claimVerifies a respondent has a claim on a specific business
put/respondents/edit-account-status/{party_id}Edit the account status of a respondent
post/pending-survey-respondentCreate a respondent for share/transfer survey
get/respondents/{respondent_id}/password-verification-tokenGet the password verification token for a respondent
post/respondents/{respondent_id}/password-verification-tokenSet the password verification token for a respondent
get/respondents/{respondent_id}/password-reset-counterGet the password reset counter for a respondent
delete/respondents/{respondent_id}/password-reset-counterReset the password reset counter for a respondent

respondents

Changes to Get a respondent by party_id

get/respondents/party_id/{party_id}

Oct 11, 20245f5cdf1ec4f1 Revision changes
- info
  endpoint added