GetTimeOffResponse
¶
Source code in docs_src/capo_connectscheduling/types/get_time_off_response.py
created_at
instance-attribute
¶
created_at: datetime
The timestamp when the time off request was created.
created_by
instance-attribute
¶
created_by: ActorInfo
The identity that created the request. Immutable for the life of the request.
description
instance-attribute
¶
description: NotRequired[Description]
The description of the time off request. CreateTimeOff sets it, and CancelTimeOff replaces or removes it. An edit in the Connect Customer admin website can also change it. GetTimeOff doesn't return descriptions sent with ApproveTimeOff or RejectTimeOff.
end_at
instance-attribute
¶
end_at: datetime
The end of the time off window, exclusive, as sent to CreateTimeOff.
shift_activity_id
instance-attribute
¶
shift_activity_id: ShiftActivityId
The identifier of the shift activity for the time off request.
start_at
instance-attribute
¶
start_at: datetime
The start of the time off window, inclusive, as sent to CreateTimeOff.
status
instance-attribute
¶
status: TimeOffStatus
The status of the time off request.
-
PENDING: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a requestPENDING, so anAPPROVEDrequest can becomePENDINGand then endAPPROVEDorREJECTED. -
AWAITING_APPROVAL: the request is waiting for anApproveTimeOfforRejectTimeOffcall.
updated_at
instance-attribute
¶
updated_at: datetime
The timestamp when the time off request was last modified.
updated_by
instance-attribute
¶
updated_by: NotRequired[ActorInfo]
The identity that made the most recent ApproveTimeOff, RejectTimeOff, or CancelTimeOff call on the request, or took the same action in the Connect Customer admin website. Absent until one of those actions is taken, including after Connect Customer decides an AUTOMATIC request. UpdatedAt also changes when a PENDING request changes to another status and for other edits, which don't set UpdatedBy.
validation_results
instance-attribute
¶
validation_results: NotRequired[TimeOffValidationResults]
Warnings or failures produced while processing the time off request.