Handle Resource Absence Action

Remove a service resource’s visit assignments for a specified period and optionally update the status of the affected visits to a specified value.

This action is available in API version 58.0 and later.

Special Access Rules

The Remove Visit Assignments action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/handleResourceAbsence

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`endDateTime`	datetime	Required. End date and time of the period to remove service resource assignments from home visits.
`newServiceAppointmentStatus`	string	Status of affected service appointments after the service resource has been removed.
`serviceResourceId`	string	Required. ID of the service resource record to remove from home visits.
`startDateTime`	datetime	Required. Start date and time of the period to remove service resource assignments from home visits.

Outputs

None.

Example

POST

This sample request is for the Handle Resource Absence action.

1{ 
2  "inputs" : [
3    {
4      "endDateTime" : "2023-07-04T12:15:45.200-700",
5      "newServiceAppointmentStatus" : "Resolved",
6      "serviceResourceId" : "0Hnxx0000004C92CAE",
7      "startDateTime" : "2023-07-04T11:00:56.235-700"
8    }
9  ]
10}

This sample response is for the Handle Resource Absence action.

1[ {
2  "actionName" : "handleResourceAbsence",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : null,
6  "version" : 1
7} ]