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.
...
Overview
This method is used 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 | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Int32 | No | Click here for more information. | |||||||||||
String | Yes | Click here for more information. | String | Yes | Click here for more information. | CutoffDate | DateTime | No | The end of last week | ??? | |||
CutoffDate | DateTime | 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 in the responsefuture 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> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
...
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
...
???
...
HistoricalReportedTimeOffs
...
PwsHistoricalReportedTimeOff[]
...
This data structure captures the details of a reported time off.
...
ScheduledHolidaysFuture
...
...
This data structure contains the resource's future holiday time off details.
...
ScheduledTimeOffFuture
...
...
This data structure captures details of the scheduled time off in the future.
...
ScheduledTimeOffPast
...
...
|
Response Elements
Element | Data Type | Description |
|---|---|---|
Messages | PwsMessage [ ] | 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 | Past reported time off entered by the resource (reported time off from start of last year up to and including the cutoff date). | |
ScheduledHolidaysFuture | PwsHolidayPto [ ] | Future holidays for the resource (holidays after the specified cutoff date). |
ScheduledTimeOffRequestSummary | Information about the resource's scheduled time off, including any scheduled time off ending after the cutoff date. Rejected time off requests are included. If IncludePastRequestedTimeOffFlag is true, includes time off going back to the start of the previous year. | |
ScheduledTimeOffSummary | Information about the resource's scheduled time off, including any scheduled time off starting before the end of the current year and ending after the cutoff date. Excludes rejected scheduled time off. | |
SchedulingGranularityMinutes | Int32 | The installation's scheduling granuality in minutes. |
TimeOffReasons |
A list of available time off reasons. |
Response Usage Example(s)
...