Tross
Demo dataBook a demo
ATHENA PROD

Fetch session types

List available goal session settings.

POSThttps://preview.ontross.com/api/integrations/athena-prod/fetch-session-types
Request Fields
input.org_id
integer
required
Practice context, shown in the athenanet portal URL.
Example
25910
input.department_id
integer
required
Department the session opens, shown in the portal URL.
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
session_types
array
Session settings available for behavioral goals, with ids.
session_types[].id
string
Catalog entry identifier returned by the upstream service.
Example
"907"
session_types[].name
string
Label of the catalog template, session type, or modality.
Example
"Practice deep breathing techniques"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena-prod/fetch-session-types \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":25910,"department_id":1},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": 25910,
    "department_id": 1
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "session_types": [
      {
        "id": "907",
        "name": "Practice deep breathing techniques"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}