Tross
Demo dataBook a demo
ECLINICALWORKS

Fetch providers

List schedulable providers and resources.

POSThttps://preview.ontross.com/api/integrations/ecw/fetch-providers
Request Fields
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
providers
array
Bookable providers with their eCW ids and names.
providers[].id
string
Scheduling system identifier for a bookable clinician.
Example
"108742"
providers[].name
string
Display label for a clinician on the scheduling page.
Example
"Morgan Avery, MD"
resources
array
Bookable resource list, or the appointment's raw resource string.
resources[].id
string
Scheduling system identifier for a bookable resource.
Example
"209563"
resources[].name
string
Display label for a resource on the scheduling page.
Example
"Exam Room 3"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/fetch-providers \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {},
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "providers": [
      {
        "id": "108742",
        "name": "Morgan Avery, MD"
      }
    ],
    "resources": [
      {
        "id": "209563",
        "name": "Exam Room 3"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}