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.
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
...
Element
...
Data Type
...
Required?
...
Default
...
Description
...
...
Int32
...
No
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.
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description |
|---|---|---|---|---|
Int32 | No | Click here for more information. | ||
String | Yes | Click here for more information. | ||
SessionTicketCutoffDate | DateTime | String | Yes | Click here for more information. |
CutoffDate | DateTime | No | The end of last week | ??? |
No | The end of last week | Time off prior to this date is considered to be "in the past". and after this date considered to be "in the future". This date must be set to the last day of a week based upon your account's first day of week setting. If it is not, that last day of the week prior to the specified date will be used. If you do not specify a value for this date, the last day of the week prior to the current date will be used. | ||
IncludePastRequestedTimeOffFlag | Boolean | No | 0 | If set to true, past requested time offs are included future scheduled time off returned in the response will include time off prior to the specified cutoff date. |
ResourceIdentity | Yes | This structure represents the unique key fields associated with identifying a resourceIdentifies the resource to retrieve time off information for. |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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 | The web service response status and message. Click here for more information. | |
Int32 | Click here for more information. | |
RequestStatus | Click here for more information. | |
DateTime | Click here for more information. | |
CutoffDate | DateTime??? | The cutoff date (see above). It will reflect the actual cutoff date, so that it will have been adjusted to represent the last day of a week. |
HistoricalReportedTimeOffs | This data structure captures the details of a Past reported time off entered by the resource. | |
ScheduledHolidaysFuture | This data structure contains Future holidays for the resource's future holiday time off details. | |
ScheduledTimeOffFuture | This data structure captures details of the scheduled time off in the futureForward looking scheduled time off requests for the resource, typically including upcoming time off and requests yet to be approved. Includes information about the approval status of the request if not yet approved. | |
ScheduledTimeOffPast | This data structure captures details of the scheduled time off in the pastScheduled time off up to end of current year. | |
SchedulingGranularityMinutes | Int32 | The installation's scheduling granuality in minutes. |
TimeOffReasons | This data structure contains the details about one time off reason for a resourceA list of available time off reasons. |
Response Usage Example(s)
...