Ecw List patient document folders

POSThttps://preview.ontross.com/api/integrations/ecw/list-patient-document-folders

input.patient_id

string

required

Same patient identifier, in the snake_case spelling these operations expect.

Example

"348144"

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"

folders

array

Patient Documents folders, each with its document list.

folders[].name

string

Source folder display label used for download selection.

Example

"Consultations (2)"

folders[].document_count

integer

How many documents eCW lists in this folder.

Example

2

folders[].documents

array

Documents in the folder, or the PDFs this call saved.

folders[].documents[].name

string

Normalized document display label used for download selection.

Example

"Cardiology consultation"

folders[].documents[].file_name

string

Source filename from eCW, or the saved PDF's name.

Example

"consultation_20261006.pdf"

total_folders

integer

Number of document folders returned.

Example

4

total_documents

integer

Documents counted across every folder returned.

Example

12

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/list-patient-document-folders \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patient_id":"348144"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patient_id": "348144"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "folders": [],
    "total_folders": 4,
    "total_documents": 12
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}