/
PwsGetResourceWorkingSchedule

PwsGetResourceWorkingSchedule

Owned by Bettina Borces
Last updated: about 9 hours ago

Overview


This web service retrieves a resource's working schedule (their planned working hours and company holidays) for a specified date range.


Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


PwsGetResourceWorkingSchedule Request
  • PwsGetResourceWorkingSchedule

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.

AcsjFlnb6JTLhBDDgVd7bg==

EndDate

DateTime

Yes 

The EndDate (in UTC format) and the StartDate (in UTC format) defines the period of the resource's schedule that should be retrieved

2018-03-31T00:00:00.000Z

ResourceIdentity

PwsResourceRef

No 

The resource associated with the schedule when other than the authenticated user. If a resource identity is not specified the schedule of the authenticated user will be submitted.


StartDate

DateTime

Yes 

See EndDate

2018-03-28T00:00:00.000Z

Request Usage Example(s)


Example 01 
<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:PwsGetResourceWorkingSchedule>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AcsjFlnb6JTLhBDDgVd7bg==</req:SessionTicket>
            <tim:EndDate>2018-03-31T00:00:00.000Z</tim:EndDate>
            <tim:StartDate>2018-03-28T00:00:00.000Z</tim:StartDate>
         </pws:serviceRequest>
      </pws:PwsGetResourceWorkingSchedule>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetResourceWorkingSchedule Response

Response Elements


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-21T14:26:20.2162604Z 

WorkingSchedule

PwsWorkingScheduleDay[]

The complete details of a resource's working schedule. Each day within the specified range is represented by a single record.


Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetResourceWorkingScheduleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetResourceWorkingScheduleResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-21T14:26:20.2162604Z</ServerTimestampUtc>
            <a:WorkingSchedule>
               <a:PwsWorkingScheduleDay>
                  <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                  <a:CanEnterTimeFlag>true</a:CanEnterTimeFlag>
                  <a:CanViewTimeFlag>true</a:CanViewTimeFlag>
                  <a:Date>2018-03-28T00:00:00Z</a:Date>
                  <a:HolidayMinutes>0</a:HolidayMinutes>
                  <a:ResourceInactiveFlag>false</a:ResourceInactiveFlag>
                  <a:TrackMissingTimeFlag>true</a:TrackMissingTimeFlag>
                  <a:WorkingMinutes>480</a:WorkingMinutes>
               </a:PwsWorkingScheduleDay>
               <a:PwsWorkingScheduleDay>
                  <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                  <a:CanEnterTimeFlag>true</a:CanEnterTimeFlag>
                  <a:CanViewTimeFlag>true</a:CanViewTimeFlag>
                  <a:Date>2018-03-29T00:00:00Z</a:Date>
                  <a:HolidayMinutes>0</a:HolidayMinutes>
                  <a:ResourceInactiveFlag>false</a:ResourceInactiveFlag>
                  <a:TrackMissingTimeFlag>true</a:TrackMissingTimeFlag>
                  <a:WorkingMinutes>480</a:WorkingMinutes>
               </a:PwsWorkingScheduleDay>
               <a:PwsWorkingScheduleDay>
                  <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                  <a:CanEnterTimeFlag>true</a:CanEnterTimeFlag>
                  <a:CanViewTimeFlag>true</a:CanViewTimeFlag>
                  <a:Date>2018-03-30T00:00:00Z</a:Date>
                  <a:HolidayMinutes>480</a:HolidayMinutes>
                  <a:ResourceInactiveFlag>false</a:ResourceInactiveFlag>
                  <a:TrackMissingTimeFlag>true</a:TrackMissingTimeFlag>
                  <a:WorkingMinutes>480</a:WorkingMinutes>
               </a:PwsWorkingScheduleDay>
               <a:PwsWorkingScheduleDay>
                  <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                  <a:CanEnterTimeFlag>true</a:CanEnterTimeFlag>
                  <a:CanViewTimeFlag>true</a:CanViewTimeFlag>
                  <a:Date>2018-03-31T00:00:00Z</a:Date>
                  <a:HolidayMinutes>0</a:HolidayMinutes>
                  <a:ResourceInactiveFlag>false</a:ResourceInactiveFlag>
                  <a:TrackMissingTimeFlag>true</a:TrackMissingTimeFlag>
                  <a:WorkingMinutes>0</a:WorkingMinutes>
               </a:PwsWorkingScheduleDay>
            </a:WorkingSchedule>
         </PwsGetResourceWorkingScheduleResult>
      </PwsGetResourceWorkingScheduleResponse>
   </s:Body>
</s:Envelope>


PwsGetResourceWorkingSchedule - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

10116InvalidDateValueSpecifiedThe date specified in the field "StartDate" in the class "PwsGetResourceWorkingScheduleRq" is invalid or out of range. The time component of the specified date must be midnight UTC.
50223NoPermissionToActOnBehalfOfResourceThe specified user does not have permission to act on behalf of this resource.
57545ResourceNotFoundThe specified resource does not exist.