Overview

This data strcture is part of the response of method PwsGetResourcePto and is used to capture forward looking scheduled time off requests for the resource. It typically includes upcoming time off and requests yet to be approved and information about the approval status of the request if not yet approved.

Format

PwsScheduledTimeOffPto

PwsScheduledTimeOffPto
- ScheduledTimeOffId: Int32
- ScheduledTimeOffUid: Int64
- ApprovalStatus: String
- BeginDate: DateTime
- DailyTimeOffMinutes: Int32
- EffectiveTimeOffMinutes: Int32
- EndDate: DateTime
- RejectedByUser: PwsUserSummary
- RejectedReason: String
- RejectedTimestamp: DateTime
- TimeOffComment: String
- TimeOffReasonIdentity: PwsTimeOffReasonRef
- TimeOffYear: Int32
- Timestamp: Byte[]

Elements

Element	Data Type	Description
ScheduledTimeOffId	Int32	The scheduled time off Id is a unique identifier for a scheduled time off record. For internal use only.
ScheduledTimeOffUid	Int64	The scheduled time off UID is a unique and immutable identifier for a scheduled time off record.
ApprovalStatus	String	The approval status of a scheduled time off request. "A" for approved, "R" for rejected and "P" for requested (pending approval).
BeginDate	DateTime	The begin date of the time off request.
DailyTimeOffMinutes	Int32	The amount of time per day requested, expressed in minutes. Use 1440 for a full day.
EffectiveTimeOffMinutes	Int32	The total time off, expressed in minutes, for the entire duration of the time off request, constrained by the resource's working minutes.
EndDate	DateTime	The end date of the time off request.
RejectedByUser	PwsUserSummary	If rejected, the user who rejected the scheduled time off request.
RejectedReason	String	The reason associated with the rejection.
RejectedTimestamp	DateTime	The date and time that the request was rejected.
RemainingAvailableTimeOffMinutes	Int32	Remaining time available for the given time off reason as of the end of this PTO, expressed in minutes.
TimeOffComment	String	The commets associated with the time off request.
TimeOffReasonIdentity	PwsTimeOffReasonRef	The time off reason associated with the time off request.
TimeOffYear	Int32	The year of the begin date for this time off request.
Timestamp	Byte[]	Timestamp of time off request, for optimistic locking.

Usage Example(s)

Example 01

               <a:PwsScheduledTimeOffPto>
                  <ScheduledTimeOffId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <ScheduledTimeOffUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607591581</ScheduledTimeOffUid>
                  <a:ApprovalStatus>P</a:ApprovalStatus>
                  <a:BeginDate>2022-12-28T00:00:00</a:BeginDate>
                  <a:DailyTimeOffMinutes>1440</a:DailyTimeOffMinutes>
                  <a:EffectiveTimeOffMinutes>3600</a:EffectiveTimeOffMinutes>
                  <a:EndDate>2023-01-04T00:00:00</a:EndDate>
                  <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:RejectedReason i:nil="true"/>
                  <a:RejectedTimestamp>0001-01-01T00:00:00</a:RejectedTimestamp>
                  <a:TimeOffComment>Post Xmas + 2</a:TimeOffComment>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Vacation</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606854584</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
                  <a:TimeOffYear>2022</a:TimeOffYear>
                  <a:Timestamp>AAAAAB9q2r4=</a:Timestamp>
				  <a:RemainingAvailableTimeOffMinutes>2400</a:RemainingAvailableTimeOffMinutes>
               </a:PwsScheduledTimeOffPto>