API Reference

How to add a care provider

Creating Care provider accounts by Clinics.

This section will explain how to add a care provider by clinic admin

A clinic can create a care provider account and assign a client to him trough the creating account.

1- Request URL: 

https://gwi.dv.optt.ca/gateway/profile/clinic/caregiver

2- Request Method Type:

POST

3- Request Input Parameters:

Body

{
  "activationStatus": "ACTIVE",
  "clientIds": [
    1
  ],
  "clinicId": 1,
  "email": "[email protected]",
  "language": "EN",
  "mobile": "093",
  "name": "c1",
  "position": "Psychologist"
}

*Body description:

Parameter NameParameter TypeDescription
nameStringCare provider's full name
emailStringCare provider’s email address [standard email format]
mobileStringCare provider’s cell phone number
positionstringCare provider position in the clinic
activationStatusstringEach care provider's account status includes one of the following options:
[ ACTIVE, INACTIVE, OPEN, PENDING, VERIFIED, DECLINED, INVITED ]
clientIdsList
(Optional)		List of all clients who are going to be assigned to this care provider. It is optional.

A complete example of an API call:

curl -X POST "https://gwi.dv.optt.ca/gateway/profile/clinic/caregiver" -H "accept: */*" -H "Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM3NTgyMDY0NDQsInVzZXJfbmFtZSI6ImxhbGVoQG9wdHQuY2EiLCJhdXRob3JpdGllcyI6WyJDTElOSUMiXSwianRpIjoiMjU5NTgwMTAtZWVkMC00MThkLTlmNzctZWU1YzA3OWU0Mzc3IiwiY2xpZW50X2lkIjoib3B0dC0wMmVlNzdkYy1hYzQ1LTQzNDQtODE3ZS0xN2NhNTJiNThiNWQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXX0.Qx07ooEYUh_i6p-ieR1w__IKj8AxIC7qeOXRHYRqJkh1IYo_wGmM1zv_qaiB9e9Gxk9yob8NalQsyJ5Knte08vyEg3bAF94fey1rXBjbmgwsLtz9lH2GaIqyw030vCv7fbbw1q-R2-drM31dRmhRy981gykA0Vo-F2ypOnYeu7FcJJxLGVs8Tu4bImCDNsKeqkCj81R_j3YFu1uigYjPbWzCRFG6xKATJrGU-fFhbr_m-WpiIIFZCoi12EK18C_Ikf1ClBDk78GHYEs6NFb4hH7Hmd5yQjDHwtgQb78uzWMUS7jQYtYw7W3tULCT3K_FZRJBNwMxWAbRMHQVcLoFRA" -H "offset: 1" -H "Content-Type: application/json" -d "{ \"activationStatus\": \"ACTIVE\", \"clientIds\": [ 1 ], \"clinicId\": 1, \"email\": \"[email protected]\", \"language\": \"EN\", \"mobile\": \"093\", \"name\": \"c1\", \"position\": \"Psychologist\"}"

Response:

201

access-control-allow-credentials: true 
 access-control-allow-origin: https://gwi.dv.optt.ca 
 cache-control: max-age=1, no-cache 
 connection: keep-alive 
 content-length: 0 
 date: Sat, 13 Feb 2021 08:55:44 GMT 
 expires: Sat, 13 Feb 2021 08:55:45 GMT 
 location: /clinic/caregiver/3 
 pragma: no-cache 
 server: nginx/1.18.0 (Ubuntu) 
 vary: Origin, Access-Control-Request-Method, Access-Control-Request-Headers, Origin 
 x-content-type-options: nosniff 
 x-frame-options: DENY 
 x-xss-protection: 1; mode=block