...
This web service retrieves a resource's available time off minutes. The caller can execute the web service for a specific resource identity (PwsResourceRef) and/or time off reason identity (PwsTimeOffReasonRef). The combinations include:
- Both ResourceIdentity and TimeOffReasonIdentity specified = : The available time off for the specified resource and time off reason will be returned (note: the authenticated user must have permission to view the specified resource's available time off)
- ResourceIdentity specified, TimeOffReasonIdentity is not specified = : The available time off for the specified resource and all time off reasons will be returned (note: the authenticated user must have permission to view the specified resource's available time off)
- ResourceIdentity is not specified, TimeOffReasonIdentity is specified = : The available time off for all resources and the specified time off reason will be returned (note: the authenticated user must have permission to view one or more resource's available time off)
- Neither ResourceIdentity is not specified, TimeOffReasonIdentity is not specified = nor TimeOffReasonIdentity specified: The available time off for all resources and all time off reasons will be returned (note: the authenticated user must have permission to view one or more resource's available time off)
...
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Description | Sample Data |
|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 |
SessionTicket | String | Yes | Click here for more information. | ASIpnfWeYNJkYt6nFvepDA== |
EndDate | DateTime | No | The StartDate and EndDate |
defines the period |
for which |
to retrieve available time off |
data. | |||
ResourceIdentity | No | The identity of the resource |
. | |||
StartDate | DateTime | No | See EndDate. |
TimeOffReasonIdentity | No | The identity of the time off reason |
. |
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:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetResourceAvailableTimeOff>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>ASIpnfWeYNJkYt6nFvepDA==</req:SessionTicket>
<req:EndDate>2018-12-31T00:00:00.000Z</req:EndDate>
<req:ResourceIdentity>
<com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
</req:ResourceIdentity>
<req:StartDate>2018-01-01T00:00:00.000Z</req:StartDate>
<req:TimeOffReasonIdentity>
<com:TimeOffReasonName>Vacation</com:TimeOffReasonName>
</req:TimeOffReasonIdentity>
</pws:serviceRequest>
</pws:PwsGetResourceAvailableTimeOff>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. |
ResponseId | Int32 | Click here for more information. |
Status | Click here for more information. |
ServerTimestampUtc | DateTime | Click here for more information. |
ResourceAvailableTimeOffSchedule |
The resource available time off schedule |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 50045 | ViewPermissionDenied | You do not have permission to view this item. |
| 57545 | ResourceNotFound | The specified resource does not exist. |
| 57567 | SpecifiedTimeOffReasonDoesNotExist | The specified time off reason does not exist. |