ResolveAgentLeavePetition

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/resolveagentleavepetition

WFM

Resolves the given @agent_leave_petition_id, setting the given parameters, for the org sending the request.
May only resolve leave petitions that currently have a PENDING_PETITION status.
May only set the @petition_status to APPROVED_PETITION or DENIED_PETITION.
If a petition is approved, time off shifts will be added to the agent's schedule across the requested_datetime_ranges.
If @retain_partial_shifts is true, partial shifts overlapping the requested_datetime_ranges will have the remaining portion of the shift retained,
if the remaining portion of the shift is at least 30 minutes in length.
If @retain_partial_shifts is false, the entirety of shifts overlapping the requested_datetime_ranges range will be deleted or transfered depending on @replace_with_unassigned_agent.
If @replace_with_unassigned_agent is true, an unassigned agent sid will be assigned to the covered shifts instead of deleting them.
When @replace_with_unassigned_agent is true, if @retain_partial_shifts is also true, only the portion of the shift in the requested datetime ranges will be transfered.
When @replace_with_unassigned_agent is true, if @retain_partial_shifts is false, the entirety of any overlapping shifts will be transfered.
Errors:

grpc.Invalid: the request data is invalid, the @agent_leave_petition_id is not pending approval.

grpc.Internal: error occurs when resolving the agent leave petition, or modifying the agent's schedule.

grpc.NotFound: the @agent_leave_petition_id does not exist for the org sending the request.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request message for the ResolveAgentLeavePetition.

petition_status

enum<string>

petition_status

optional

The status to resolve the petition to.

Allowed values:

UNSPECIFIED_PETITION_STATUSPENDING_PETITIONAPPROVED_PETITIONDENIED_PETITIONCANCELLED_PETITION

response_comment

string

response_comment

optional

An optional comment to explain the approval or denial of the leave petition.

retain_partial_shifts

boolean

retain_partial_shifts

optional

If true, partial shifts overlapping the requested_datetime_ranges will have the remaining portion of the shift retained
if the remaining portion is at least 30 minutes wide.
If false, the entirety of shifts overlapping the requested_datetime_ranges will be deleted or transfered, depending on @replace_with_unassigned_agent.

replace_with_unassigned_agent

boolean

replace_with_unassigned_agent

optional

If @replace_with_unassigned_agent is true, an unassigned agent sid will be assigned to the shifts instead of deleting them.
If @retain_partial_shifts is also true, only the portion of the shift in the requested datetime ranges will be transfered.
if @retain_partial_shifts is false, the entirety of any overlapping shifts will be transfered.

agent_leave_petition_id

integer <int64> | string

agent_leave_petition_id

optional

ID of the agent leave petition to approve or deny.

Example

{
  "petition_status": "UNSPECIFIED_PETITION_STATUS",
  "response_comment": "string",
  "retain_partial_shifts": true,
  "replace_with_unassigned_agent": true,
  "agent_leave_petition_id": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/resolveagentleavepetition' \
--header 'Content-Type: application/json' \
--data-raw '{
    "petition_status": "UNSPECIFIED_PETITION_STATUS",
    "response_comment": "string",
    "retain_partial_shifts": true,
    "replace_with_unassigned_agent": true,
    "agent_leave_petition_id": 0
}'

Responses

🟢200OK

application/json

Success

Body

Response message for the ResolveAgentLeavePetition.

agent_leave_petition

object (AgentLeavePetition)

agent_leave_petition

optional

The resolved Agent Leave Petition.

petition_status

enum<string>

petition_status

optional

Current status of the time off request.

Allowed values:

UNSPECIFIED_PETITION_STATUSPENDING_PETITIONAPPROVED_PETITIONDENIED_PETITIONCANCELLED_PETITION

created_time

string <date-time>

created_time

optional

The timestamp from when the request was created.

Examples:

1s1.000340012s

archived_time

string <date-time>

archived_time

optional

The timestamp from when the timestamp was archived, if it has been archived.
This field is null by default.

Examples:

1s1.000340012s

resolved_time

string <date-time>

resolved_time

optional

The timestamp from when the timestamp was resolved, if it has been resolved.
The request is resolved when it is either approved or denied.
This field is null by default.

Examples:

1s1.000340012s

petition_comment

string

petition_comment

optional

A comment sent by agent when the time off was requested.

response_comment

string

response_comment

optional

A response from the manager when the request was approved or denied.
This field is null by default.

requested_datetime_ranges

array[object (DatetimeRange) {2}]

requested_datetime_ranges

optional

A list of datetime ranges to be blocked off on the schedule.

resolved_by_user_id

string

resolved_by_user_id

optional

The user ID of the manager who approved or denied the request.
This field is null by default.

requested_hours_off

number <float>

requested_hours_off

optional

The number of working hours requested off.
This does not need to relate directly to the datetime range being requested off,
For example in the case where a 14 hour schedulable range is being taken off but 8 hours of work will be paid out with PTO.

agent_leave_petition_id

integer <int64> | string

agent_leave_petition_id

optional

ID of the agent leave petition.

wfm_agent_sid

integer <int64> | string

wfm_agent_sid

optional

ID of the agent requesting the time off.

Example

{
  "agent_leave_petition": {
    "petition_status": "UNSPECIFIED_PETITION_STATUS",
    "created_time": "1s",
    "archived_time": "1s",
    "resolved_time": "1s",
    "petition_comment": "string",
    "response_comment": "string",
    "requested_datetime_ranges": [
      {
        "start_datetime": "1s",
        "end_datetime": "1s"
      }
    ],
    "resolved_by_user_id": "string",
    "requested_hours_off": 0,
    "agent_leave_petition_id": 0,
    "wfm_agent_sid": 0
  }
}

🔴500Server Error

ArchiveAgentLeavePetition

CancelAgentLeavePetition