Ezderm Download patient document file

POSThttps://preview.ontross.com/api/integrations/ezderm/download-patient-document-file

input.patient_id

string

required

Patient UUID checked against the attachment's recorded owner.

Example

"3f2504e0-4f89-11d3-9a0c-0305e82c3301"

input.file_id

string

required

Attachment UUID obtained from the patient's document directory listing; its original letter case is preserved.

Example

"E8C317A4-6F29-4D05-B782-93A60C1F254E"

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"

file_id

string

Requested attachment UUID with its original letter case preserved.

Example

"e8c317a4-6f29-4d05-b782-93a60c1f254e"

filename

string

Server attachment label, falling back to the requested UUID.

Example

"intake-questionnaire.pdf"

mime_type

string

Server content type, defaulting to application/octet-stream when unavailable.

Example

"application/pdf"

content_base64

string

Downloaded attachment bytes encoded as base64 text.

Example

"SW50YWtlIHF1ZXN0aW9ubmFpcmUK"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ezderm/download-patient-document-file \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patient_id":"3f2504e0-4f89-11d3-9a0c-0305e82c3301","file_id":"E8C317A4-6F29-4D05-B782-93A60C1F254E"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patient_id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
    "file_id": "E8C317A4-6F29-4D05-B782-93A60C1F254E"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "file_id": "e8c317a4-6f29-4d05-b782-93a60c1f254e",
    "filename": "intake-questionnaire.pdf",
    "mime_type": "application/pdf",
    "content_base64": "SW50YWtlIHF1ZXN0aW9ubmFpcmUK"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}