Assignments
Create, update, cancel and reassign assignments; mark no-shows; read and export.
36 operations in 8 areas · Download the OpenAPI document
Assignments 12
- GETRetrieve a list of assignments
/assignments - POSTCreate a new assignment
/assignments - GETRetrieve default options for assignment shift dropdowns
/assignment-default-options - GETGet Assignment Summary Tab Details
/assignment-summary/{id}/{tab} - DELETEDelete assignment files by file IDs
/assignment/document/files - GETRetrieve assignment providers
/assignment/{id}/providers/{serviceType}/{status} - GETRetrieve specific tab details of a assignment
/assignment/{id}/{tab} - DELETEDelete an assignment
/assignments/{assignment} - POSTUpdate an existing assignment
/assignments/{id} - GETGet financial summary for an assignment
/assignments/{id}/financial-summary - POSTResolve client/consumer/org default or override preferences for the assignment/shift form
/preference - PATCHUpdate notes on an assignment or shift
/{type}/notes/{id}
Provider portal 6
- GETRetrieve service provider assignments
/settings/portal/provider/assignment - POSTMark assignment as complete
/settings/portal/provider/assignment/assignment-complete/{id} - POSTStore or update assignment expenses
/settings/portal/provider/assignment/provider-expenses - GETRetrieve single assignment details
/settings/portal/provider/assignment/{id} - GETGet assignment available slots
/settings/portal/provider/assignment/{id}/slots - PATCHWithdraw or edit coverage for an assignment
/settings/portal/provider/assignment/{type}/{id}
No-shows and provider status 5
- POSTMark a client as No Show on an assignment
/assignment-clients/{id}/no-show - DELETEReverse a client No Show mark
/assignment-clients/{id}/no-show - PATCHUpdate provider status for an assignment
/assignment-providers/{id} - POSTMark an assigned provider as No Show
/assignment-providers/{id}/no-show - DELETEReverse a provider No Show mark
/assignment-providers/{id}/no-show
Cancel, change and reassign 4
- POSTRequest cancellation of an assignment or shift (client and consumer)
/assignment/cancel-assignment - POSTReassign an assignment
/assignment/re-assign - POSTSubmit a change request for an assignment or shift
/assignment/request-change-assignment - POSTSend a message related to an assignment
/assignment/send-message