Athena Prod Add session note

POSThttps://preview.ontross.com/api/integrations/athena-prod/add-session-note

input.org_id

integer

required

Athena practice ID.

Example

12345

input.department_id

integer

required

Athena department ID for the practice.

Example

10

input.appointment_id

string

required

Athena appointment ID as a string. The appointment group is found automatically.

Example

"987654"

input.freetext

string

required

Session note HTML to save. This replaces the group's current free-text note.

Example

"<div>Session note text.</div>"

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"

appointment_group_id

string

Appointment group ID resolved from the appointment and returned by Athena.

Example

"2468"

appointment_id

string

Appointment ID supplied in the request.

Example

"987654"

freetext

string

Session note HTML returned by Athena after the save.

Example

"<div>Session note text.</div>"

version

integer

Saved documentation version returned by Athena, or null if Athena omits it.

Example

7

is_locked

boolean

Whether Athena reports the saved group note as locked.

Example

false

curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena-prod/add-session-note \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":12345,"department_id":10,"appointment_id":"987654","freetext":"<div>Session note text.</div>"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "org_id": 12345,
    "department_id": 10,
    "appointment_id": "987654",
    "freetext": "<div>Session note text.</div>"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "appointment_group_id": "2468",
    "appointment_id": "987654",
    "freetext": "<div>Session note text.</div>",
    "version": 7,
    "is_locked": false
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}