Worker documents

Any API POST/PUT request won’t trigger a workflow.

GET /documents-workers

Retrieves all worker documents (metadata only, no file content or download). Parameters: None. Returns all worker documents in a single unpaginated response. Response:

[
  {
    "DocId": 1705,
    "CarerId": 4472,
    "DocumentName": "MyCareConnect_User Guide Mob April 2020.pdf",
    "Note": "",
    "Protected": 0,
    "VisibleCarerMobile": 0,
    "VisibleClientMobile": 0,
    "CreatedBy": "user@example.com",
    "CreatedAt": "2020-04-20 10:15:32"
  }
]

Response fields:

Field	Type	Notes
`DocId`	integer
`CarerId`	integer
`DocumentName`	string	Original filename
`Note`	string
`Protected`	integer	0/1
`VisibleCarerMobile`	integer	0/1
`VisibleClientMobile`	integer	0/1
`CreatedBy`	string	Email
`CreatedAt`	string	Datetime

This endpoint returns metadata only. File content is not included and there is no endpoint to download a file by DocId. CategoryId and file size are not returned.

POST /worker-doc

Uploads a document to a worker’s profile. Required fields: file, CarerId Conditionally required: CategoryId (when your organisation mandates a category on upload) Content-Type: multipart/form-data Curl example:

curl "https://publicapi.visualcare.com.au/worker-doc" \
    -H "User: user-uuid" \
    -H "Key: key" \
    -H "Secret: secret" \
    -F "file=@/path/to/file.pdf" \
    -F "CarerId=1303" \
    -F "CategoryId=2" \
    -F "VisibleCarer=TRUE" \
    -F "VisibleClient=FALSE" \
    -F "Protect=TRUE"

Form fields:

Field	Required	Type	Description
`file`	Yes	file	The document to upload
`CarerId`	Yes	integer	Worker ID to attach the document to
`CategoryId`	Conditional	integer	Document category (from `/category-documents`)
`VisibleCarer`	No	string	`"TRUE"` / `"FALSE"` - visible to the worker on mobile
`VisibleClient`	No	string	`"TRUE"` / `"FALSE"` - visible to the client on mobile
`Protect`	No	string	`"TRUE"` / `"FALSE"` - mark the document as protected

PUT /worker-doc

Updates metadata on an existing worker document. Required fields: LinkId Content-Type: application/json Request body:

{
  "LinkId": 11110,
  "VisibleCarer": "TRUE",
  "VisibleClient": "FALSE"
}

Overview

Clients

Workers

Categories

Organisation

Scheduling

People

Incidents

Records

GET /documents-workers

POST /worker-doc

PUT /worker-doc

​GET /documents-workers

​POST /worker-doc

​PUT /worker-doc

GET /documents-workers

POST /worker-doc

PUT /worker-doc