ATHENA PROD

Fetch practice

Get the practice and all of its departments.

POSThttps://api.ontross.com/api/integrations/athena-prod/fetch-practice

Request Fields

input.org_id

integer

Athena practice ID. Omit it: the connection already knows its practice. Required only for a connection saved without one.

Example

23708

input.department_id

integer

Session department. Optional; any department of the practice works.

Example

1

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

practice_id

string

Athena practice ID: the org_id every other operation takes.

Example

"23708"

portal_route_id

string

Portal route segment the practice's pages live under.

Example

"76"

departments

array

Every department of the practice, including non-scheduling ones.

departments[].id

string

Department ID as every other operation's department_id takes it.

Example

"17"

departments[].qualified_id

string

The same department as scheduling ids carry it (<practice>-<department>).

Example

"23708-17"

departments[].name

string

Department name.

Example

"FVMG - Palmdale Ave Q"

departments[].provider_group_id

string

Provider group the department belongs to, if any.

Example

"1"

departments[].chart_sharing_group_id

string

Chart sharing group the department belongs to.

Example

"1"

departments[].ordering

integer

Athena's display order for the department, when set.

Example

20

departments[].is_deleted

boolean

Whether Athena has retired the department.

Example

false

total

integer

Number of departments returned.

Example

17

Code

curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/athena-prod/fetch-practice \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"org_id":23708,"department_id":1},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "org_id": 23708,
    "department_id": 1
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "practice_id": "23708",
    "portal_route_id": "76",
    "departments": [
      {
        "id": "17",
        "qualified_id": "23708-17",
        "name": "FVMG - Palmdale Ave Q",
        "provider_group_id": "1",
        "chart_sharing_group_id": "1",
        "ordering": 20,
        "is_deleted": false
      }
    ],
    "total": 17
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}