post Forms Requests
POST {{baseUrl}}/forms/requests?subdomain={{subdomain}}&location_id={{location_id}}&patient_id=<integer>&form_ids[]=<string>&form_ids[]=<string>&appointment_id=<integer>&due_date=<date>
Create a form request
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified institution | |
patient_id | string | (Required) Patient id | |
form_ids[] | string | (Required) An array of form ids | |
form_ids[] | string | (Required) An array of form ids | |
appointment_id | string | Appointment id | |
due_date | string | The date by which the form must be filled out by the patient |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: Created
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":{"id":"\u003cstring\u003e","url":"\u003cstring\u003e","form_ids":["\u003cstring\u003e","\u003cstring\u003e"],"request_status":"\u003cstring\u003e","sync_status":"\u003cstring\u003e","autosync":"\u003cboolean\u003e","last_synced_at":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e"},"created_at":"\u003cstring\u003e","due_date":"\u003cstring\u003e"},"count":"\u003cinteger\u003e"}