How to Creating a Session by a Care Provider (and assigning homework)

To make Session(s) of care between the Care Provider and one of their
assigned Clients.

You are the Care Provider and want to schedule Session(s) of mental health care between yourself (or another Care Provider), and one of the assigned Clients. Scheduling is also available for multiple Sessions, each of which can include assignments for the Client. Use this API as follows:

1- Request URL:

https://gwidev.eq.optt.ca/gateway/profile/caregiver/session

2- Request Method Type:
POST

3- Body

{
  "bookIdList": [
    0
  ],
  "caregiverId": 0,
  "clientId": 0,
  "clinicId": 0,
  "date": "string",
  "description": "string",
  "designPlanId": 0,
  "id": 0,
  "remindDays": 0,
  "sessionCount": 0,
  "time": "string",
  "title": "string"
}

3- Body Description

Parameter NameParameter TypeDescription
CareProviderIdLongRefers to the Care Provider who is going to get assigned to this Session
TitleStringTitle of the mental health Session
clientIdLongRefers to the Client who is going to get assigned to this Session
sessionCountIntegerNumber of Sessions that are being created (if absent will be set to 1)
bookIdListListList of homework Books that can be assigned to the Client (if set to null no homework will be assigned and just the Session(s) will be created)
descriptionStringA brief description of Session’s purpose and functions
clinicIdLongRefers to the Clinic to which the Client is registered.
dateStringThe date that the Session is created [yyyy/mm/dd]
timeStringThe time that the Session is Created [hh:mm]
remindDaysIntegerNumber of the days from the date of the creation of the session, which a reminder will be set for reminding the Client and the Care Provider about the session

A complete example of an API call:

curl -X POST "https://gwidev.eq.optt.ca/gateway/profile/caregiver/session" -H "accept: */*" -H "Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM3NTgyMDY1MjEsInVzZXJfbmFtZSI6ImxhbGVoZGVobmF2aS5sZEBnbWFpbC5jb20iLCJhdXRob3JpdGllcyI6WyJDQVJFR0lWRVIiXSwianRpIjoiOTZhYWFjOTMtMmRjNy00NDM5LWE3YTUtNWI0MzAwYmNjN2NlIiwiY2xpZW50X2lkIjoib3B0dC0wMmVlNzdkYy1hYzQ1LTQzNDQtODE3ZS0xN2NhNTJiNThiNWQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXX0.cvGtZ8jjyREqzFr2kUOhh4HTDsJOD0Y4icAO9KOt42Z_B_HngqylOs_WbDiSKduObzvfTHraDqEIxZJtAzK9YujjKcy9uKfPH_9GR-qcuFNrlrJMREib2AMzUXi9Gsqgh-hNsp1uNhlQzQuzSoKo1rAnuF6HC2m1BU77cbVnrwTdbP6e8jJz21dvav1JSUVZiqiyxVbUY2f8IA8n-sXf_284-4shnkkggbgIPTW88Jd_UOp-w2UZ-lKRWfRmKlhRVM37iamWw0hGOIW3jOJc6_fc1ce-I2O7YYBNkYdwLooBaVzXG0ja8w1PTrHBml95PcmzDLp2zg-4CRpjczSk4g" -H "offset: 1" -H "Content-Type: application/json" -d "{ \"bookIdList\": [ 3 ], \"caregiverId\": 0, \"clientId\": 1, \"clinicId\": 1, \"date\": \"2021/01/16\", \"description\": \"tst\", \"id\": 0, \"remindDays\": 2, \"sessionCount\": 0, \"time\": \"17:28\", \"title\": \"tst\"}"

Response:

{
  "message": "ok, sessions created"
}