Tross
Demo dataBook a demo
NETSMART

Fetch sites

List scheduling sites.

POSThttps://preview.ontross.com/api/integrations/netsmart/fetch-sites
Request Fields
input.system
string
Which Compass NX deployment to call, live or test.
Example
"PROD"
Default
"PROD"
Accepted values
PRODUAT
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
sites
array
Scheduling sites the signed-in user can open.
sites[].id
string
Scheduling location identifier used when requesting calendars.
Example
"97"
sites[].label
string
Display text for a selectable scheduling location.
Example
"North Clinic"
sites[].timezone
string
IANA zone the site's calendar times are given in.
Example
"America/New_York"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/netsmart/fetch-sites \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"system":"PROD"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "system": "PROD"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "sites": [
      {
        "id": "97",
        "label": "North Clinic",
        "timezone": "America/New_York"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}