Ezderm Create document folder

POSThttps://preview.ontross.com/api/integrations/ezderm/create-document-folder

input.patient_id

string

required

Patient UUID, resolved from a medical record number by list-patients.

Example

"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93"

input.folder_name

string

required

One folder under the patient's document root, no slashes allowed.

Example

"Questionnaire"

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"

folder_id

string

EZDerm id of the folder holding the document.

Example

"91A6F302-7DB4-49C8-A560-2C18E7FB934D"

patient_id

string

Patient UUID, resolved from a medical record number by list-patients.

Example

"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93"

folder_name

string

One folder under the patient's document root, no slashes allowed.

Example

"Questionnaire"

created

boolean

False when the folder already existed and was reused.

Example

true

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ezderm/create-document-folder \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patient_id":"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93","folder_name":"Questionnaire"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patient_id": "3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93",
    "folder_name": "Questionnaire"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "folder_id": "91A6F302-7DB4-49C8-A560-2C18E7FB934D",
    "patient_id": "3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93",
    "folder_name": "Questionnaire",
    "created": true
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}