Versions Compared

Key

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

...

This web service retrieves a resource's scheduled time and/or scheduled time off per day within a given date range

Request Format


Panel
titlePwsGetResourceSchedule Request
  • PwsGetResourceSchedule

...

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 scheduled time / (booked hours on projects) 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

PwsProjectRef

No 


The project identity filter. If this value is set only booked hours associated with this project will be included in the response.


ResourceIdentity

PwsResourceRef

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 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)

...

Panel
titlePwsGetResourceSchedule Response

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

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


ResponseId

Int32

Click here for more information.

1

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-20T18:09:59.6239166Z

ResourceSchedule

PwsSchedule

The full details of the resource's scheduled time or time off hours.


Response Usage Example(s)

...