Tross
Demo dataBook a demo
DENTRIX-ASCEND

Fetch operatories

List treatment rooms with optional office filtering.

POSThttps://preview.ontross.com/api/integrations/dentrix-ascend/fetch-operatories
Request Fields
input.location_ids
array
Restrict to these location ids; empty returns all.
Example
["64000000022309"]
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
operatories
array
Treatment rooms remaining after the requested office filter.
operatories[].id
string
Treatment room identifier returned by the organization lookup.
Example
"64000000010661"
operatories[].name
string
Treatment room display label from the organization record.
Example
"Operatory 1"
operatories[].short_name
string
Abbreviated treatment room label from the organization record.
Example
"OP1"
operatories[].active
boolean
Whether the organization marks this treatment room as enabled.
Example
true
operatories[].location_id
string
Office identifier from locationId or the nested location fallback.
Example
"64000000022309"
operatories[].display_order
integer
Presentation position returned with the treatment room record.
Example
1
count
integer
Total treatment rooms in the returned collection.
Example
6
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/dentrix-ascend/fetch-operatories \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"location_ids":["64000000022309"]},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "location_ids": [
      "64000000022309"
    ]
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "operatories": [
      {
        "id": "64000000010661",
        "name": "Operatory 1",
        "short_name": "OP1",
        "active": true,
        "location_id": "64000000022309",
        "display_order": 1
      }
    ],
    "count": 6
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}