Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update api docs now respondent_type on create can only be patient/profess #19

Merged
merged 1 commit into from
Jul 25, 2024
Merged

Update api docs now respondent_type on create can only be patient/profess #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion technical/rest_api/dossier/fill_out_requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion technical/rest_api/dossier/responses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading