Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This method is ued to retrieve a resource's time off information.  It includes the resource's past, future time requested, resource's reported time off and future holiday time off data. 

...

Element

Data Type

Required?

Default

Description

RequestId

Int32

No


Click here for more information.

SessionTicket

String

Yes


Click here for more information.

CutoffDate

DateTime

No

The end of last week 

???

IncludePastRequestedTimeOffFlag

Boolean

No

0

If set to true, past requested time offs are included in the response. 

ResourceIdentity

PwsResourceRef

Yes


This structure represents the unique key fields associated with identifying a resource.

Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetResourcePto>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AQs/cc+1ncna6N2MJvgt7Q==</req:SessionTicket>
            <!--Optional:-->
            <!--tim:CutoffDate>?</tim:CutoffDate-->
            <!--Optional:-->
            <tim:IncludePastRequestedTimeOffFlag>1</tim:IncludePastRequestedTimeOffFlag>
            <!--Optional:-->
            <tim:ResourceIdentity>
               <com:ResourceReferenceSystemId>ID-EM</com:ResourceReferenceSystemId>
            </tim:ResourceIdentity>
         </pws:serviceRequest>
      </pws:PwsGetResourcePto>
   </soapenv:Body>
</soapenv:Envelope>

...

Element

Data Type

Description

Messages

PwsMessage[]

The web service response status and message. Click here for more information.

ResponseId

Int32

Click here for more information.

Status

RequestStatus

Click here for more information.

ServerTimestampUtc

DateTime

Click here for more information.

CutoffDate

DateTime

???

HistoricalReportedTimeOffs

PwsHistoricalReportedTimeOff[]

This data structure captures the details of a reported time off. 

ScheduledHolidaysFuture

PwsHolidayPto[]

This data structure contains the resource's future holiday time off details. 

ScheduledTimeOffFuture

PwsScheduledTimeOffPto[]

This data structure captures details of the scheduled time off in the future.

ScheduledTimeOffPast

PwsScheduledTimeOff[]

This data structure captures details of the scheduled time off in the past.

SchedulingGranularityMinutes

Int32

The installation's scheduling granuality in minutes. 

TimeOffReasons

PwsTimeOffReasonPto[]

This data structure contains the details about one time off reason for a resource

...