Skip to content

Commit

Permalink
Update api docs now respondent_type on create can only be patient/pro…
Browse files Browse the repository at this point in the history
…fess (#19)
  • Loading branch information
Hampei authored Jul 25, 2024
1 parent 34013cf commit 21a4e65
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion technical/rest_api/dossier/fill_out_requests.md
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
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

0 comments on commit 21a4e65

Please sign in to comment.