...
This web service retrieves a resource's scheduled time and/or scheduled time off per day
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No |
Click here for more information | 1 | ||
SessionTicket | String | Yes |
Click here for more information | ATtx2+k3au/+YimAUXob5g== | |
EndDate | DateTime | Yes |
The EndDate and the StartDate (in UTC format) defines the date range that will be applied as a filter in the search | 2018-03-31T00:00:00.000Z | ||||
IncludeScheduledTimeFlag | Boolean | No | false | If set to 'true', schedule time / booked hours will be included in the response | true |
IncludeTimeOffFlag | Boolean | No | false | If set to 'true', scheduled time off will be included in the response | true |
ProjectIdentity | No |
The project identity filter. If this value is set only booked hours associated with this project will be included in the response |
ResourceIdentity | No |
The resource identity when acting on behalf of another user. If this value is not set, the scheduled time or time off hours associated with the authenticated user will be included in the response |
StartDate | DateTime | Yes |
The EndDate and the StartDate (in UTC format) defines the date range that will be applied as a filter in the search | 2018-03-28T00:00:00.000Z |
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:PwsGetResourceSchedule>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>ATtx2+k3au/+YimAUXob5g==</req:SessionTicket>
<tim:EndDate>2018-03-31T00:00:00.000Z</tim:EndDate>
<tim:IncludeScheduledTimeFlag>true</tim:IncludeScheduledTimeFlag>
<tim:IncludeTimeOffFlag>true</tim:IncludeTimeOffFlag>
<tim:ProjectIdentity>
<com:ProjectCode>P001395-001</com:ProjectCode>
</tim:ProjectIdentity>
<tim:StartDate>2018-03-28T00:00:00.000Z</tim:StartDate>
</pws:serviceRequest>
</pws:PwsGetResourceSchedule>
</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 | 1 |
Status | Click here for more information | Ok | |
ServerTimestampUtc | DateTime | Click here for more information | 2018-03-20T18:09:59.6239166Z |
ResourceSchedule | The full details of the resource's scheduled time or time off hours |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10103 | NothingToDo | There is nothing to do. |
| 20024 | StartDateRequiredForGetResourceSchedule | A start date must be specified. |
| 20025 | InvalidValueForResourceScheduleStartDate | The specified start date must be expressed as midnight UTC on the desired date. |
20026 | EndDateRequiredForGetResourceSchedule | An end date must be specified |
| 20027 | InvalidValueForResourceScheduleEndDate | The specified end date must be expressed as midnight UTC on the desired date. |
| 50045 | ViewPermissionDenied | You do not have permission to view this item. |
| 54282 | ProjectNotFound | Specified project does not exist. |
| 57545 | ResourceNotFound | The specified resource does not exist. |