From 5185ea3dc0506847fb8088887e0f15985a9d71a3 Mon Sep 17 00:00:00 2001 From: Henk Date: Wed, 10 Jul 2024 15:17:55 +0200 Subject: [PATCH] Update api docs now respondent_type on create can only be patient/profess --- technical/rest_api/dossier/fill_out_requests.md | 3 ++- technical/rest_api/dossier/responses.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/technical/rest_api/dossier/fill_out_requests.md b/technical/rest_api/dossier/fill_out_requests.md index 483e53ca..4cff1932 100644 --- a/technical/rest_api/dossier/fill_out_requests.md +++ b/technical/rest_api/dossier/fill_out_requests.md @@ -30,7 +30,8 @@ Name | Type | Description Name | Type | Description --------------------|--------------------|------------ `questionnaire_keys`| `array of string` | **Required**. List of questionnaires that need to be filled out. -`respondent_type` | `string` | Defaults to `patient_version`. +`respondent_id` | `integer` | Id of the respondent that should fill out the questionnaire. +`respondent_type` | `string` | \['patient_version'(default) \| 'profess_version'\] String identifying the respondent that should fill out the questionnaires. can be used instead of respondent_id. `callback_url` | `string` | URL to call on events (see below). `reminders` | `array of integer` | List of offsets in seconds after open_from to make a reminder callback. `open_from` | `integer` | Unix timestamp for when the questionnaires can be filled out. Defaults to Time.now diff --git a/technical/rest_api/dossier/responses.md b/technical/rest_api/dossier/responses.md index dc5fbbbd..bf25fe66 100644 --- a/technical/rest_api/dossier/responses.md +++ b/technical/rest_api/dossier/responses.md @@ -83,7 +83,7 @@ Name | Type | Description `answer_data` | `hash` | \[Required\] Hash storing the answered option key for every question key `started_at` | `integer` | The Unix time when the questionnaire was started being filled out (greater or equal to 31 december 1999) `filled_out_at` | `integer` | The Unix time when the questionnaire was filled out (greater or equal to 31 december 1999) -`respondent` | `string` | \['patient'(default) \| 'parent' \| 'second_parent' \| 'teacher' \| 'caregiver' \| 'profess'\] String identifying the respondent which filled out the questionnaire +`respondent` | `string` | \['patient'(default) \| 'profess'\] String identifying the respondent which filled out the questionnaire. `entered_by` | `string` | \[Optional, blank means response was entered by the respondent themselves.\] The user id of the professional that entered the response into the system. For responses that were not entered directly by the respondent. The user id should correspond to the user id of that professional that is used in the [EPD SSO](../../../rom/sso/epd_v3/) connection. In the case of a 'profess' respondent, the implication is that this professional was the evaluator/originator of the response data, but this is not a strict requirement. ### Response