Overview

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

Request Format

PwsGetResourceSchedule Request

PwsGetResourceSchedule
- serviceRequest: PwsGetResourceScheduleRq
  - RequestId: Int32
  - SessionTicket: String
  - EndDate: DateTime
  - IncludeScheduledTimeFlag: Boolean
  - IncludeTimeOffFlag: Boolean
  - ProjectIdentity: PwsProjectRef
  - ResourceIdentity: PwsResourceRef
  - StartDate: DateTime

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', 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.
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)

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

Response Format

PwsGetResourceSchedule Response

PwsGetResourceScheduleResponse
- PwsGetResourceScheduleResult: PwsGetResourceScheduleRs
  - Messages: PwsMessage []
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ResourceSchedule: PwsSchedule

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-20T18:09:59.6239166Z
ResourceSchedule	PwsSchedule	The full details of the resource's scheduled time or time off hours.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetResourceScheduleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetResourceScheduleResult 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-20T18:09:59.6239166Z</ServerTimestampUtc>
            <a:ResourceSchedule>
               <a:Holidays/>
               <a:Roles>
                  <a:PwsScheduleRole>
                     <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ProjectRoleId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ProjectRoleUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504609522500</ProjectRoleUid>
                     <a:AssignedTasks>
                        <a:PwsScheduleProjectTask>
                           <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <ProjectTaskId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <ProjectTaskUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608644258</ProjectTaskUid>
                           <a:Description>Task A1</a:Description>
                           <a:Name>Task A1</a:Name>
                           <a:Notes>
                              <a:PwsProjectTaskNoteHistory>
                                 <a:CreatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                    <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                                    <b:UserId i:nil="true"/>
                                    <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                                    <b:UserUid>1152921504607011056</b:UserUid>
                                 </a:CreatedByUser>
                                 <a:CreatedTimestamp>2018-03-07T18:10:20.357Z</a:CreatedTimestamp>
                                 <a:ProjectTaskNotes>This is the first task of this project</a:ProjectTaskNotes>
                              </a:PwsProjectTaskNoteHistory>
                              <a:PwsProjectTaskNoteHistory>
                                 <a:CreatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                    <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                                    <b:UserId i:nil="true"/>
                                    <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                                    <b:UserUid>1152921504607112369</b:UserUid>
                                 </a:CreatedByUser>
                                 <a:CreatedTimestamp>2018-03-07T18:24:42.013Z</a:CreatedTimestamp>
                                 <a:ProjectTaskNotes>Please speak to Jack before starting this task</a:ProjectTaskNotes>
                              </a:PwsProjectTaskNoteHistory>
                           </a:Notes>
                           <a:OpenForTimeFlag>true</a:OpenForTimeFlag>
                           <a:ParentProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:ExternalSystemIdentifier i:nil="true"/>
                              <b:ProjectTaskId i:nil="true"/>
                              <b:ProjectTaskUid>1152921504608637335</b:ProjectTaskUid>
                           </a:ParentProjectTaskIdentity>
                           <a:ParentTaskName>Task A</a:ParentTaskName>
                           <a:PlannedEndDateTime>2018-03-30T08:00:00Z</a:PlannedEndDateTime>
                           <a:PlannedStartDateTime>2018-03-01T00:00:00Z</a:PlannedStartDateTime>
                           <a:ProjectTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:ExternalSystemIdentifier i:nil="true"/>
                              <b:ProjectTaskTypeId i:nil="true"/>
                              <b:ProjectTaskTypeUid>1152921504608115974</b:ProjectTaskTypeUid>
                           </a:ProjectTaskTypeIdentity>
                           <a:Roles/>
                           <a:SequenceNumber>1</a:SequenceNumber>
                           <a:WbsCode>1.1</a:WbsCode>
                           <a:ParentTaskWbsCode>1</a:ParentTaskWbsCode>
                           <a:BudgetedMinutes>10560</a:BudgetedMinutes>
                           <a:Estimate>
                              <a:CompletedFlag>false</a:CompletedFlag>
                              <a:RemainingAsOfDate>2018-03-05T00:00:00Z</a:RemainingAsOfDate>
                              <a:RemainingMinutes>480</a:RemainingMinutes>
                           </a:Estimate>
                           <a:LateFlag>false</a:LateFlag>
                           <a:RemainingMinutesPriorToDateRange>480</a:RemainingMinutesPriorToDateRange>
                           <a:TotalMinutesToDate>0</a:TotalMinutesToDate>
                        </a:PwsScheduleProjectTask>
                     </a:AssignedTasks>
                     <a:Bookings>
                        <a:PwsScheduleBooking>
                           <a:DailyWeeklyFlag>W</a:DailyWeeklyFlag>
                           <a:Date>2018-03-25T00:00:00Z</a:Date>
                           <a:Notes xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                              <b:string i:nil="true"/>
                              <b:string i:nil="true"/>
                              <b:string i:nil="true"/>
                              <b:string i:nil="true"/>
                              <b:string i:nil="true"/>
                              <b:string i:nil="true"/>
                              <b:string i:nil="true"/>
                           </a:Notes>
                           <a:ScheduledMinutes>1200</a:ScheduledMinutes>
                        </a:PwsScheduleBooking>
                     </a:Bookings>
                     <a:ProjectDescriptor>
                        <ProjectCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">P001395-001</ProjectCode>
                        <ProjectId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <ProjectUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607412209</ProjectUid>
                        <a:ColorMapColor>0x00ffff</a:ColorMapColor>
                        <a:EngagementDescriptor>
                           <EngagementCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">E001395</EngagementCode>
                           <EngagementId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <EngagementUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607324698</EngagementUid>
                           <a:ClientDescriptor>
                              <ClientId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                              <ClientNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PR-PSA</ClientNumber>
                              <ClientUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606961482</ClientUid>
                              <a:ClientName>Projector PSA</a:ClientName>
                           </a:ClientDescriptor>
                           <a:EngagementManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                              <b:UserId i:nil="true"/>
                              <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                              <b:UserUid>1152921504607112369</b:UserUid>
                              <b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
                              <b:FirstName>Jack</b:FirstName>
                              <b:LastName>Spratt</b:LastName>
                              <b:MiddleName i:nil="true"/>
                           </a:EngagementManager>
                           <a:EngagementName>Web Services Engagement</a:EngagementName>
                           <a:EngagementTypeDescriptor>
                              <EngagementTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                              <EngagementTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Billable - Time and Materials</EngagementTypeName>
                              <EngagementTypeShortName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">TandM</EngagementTypeShortName>
                              <EngagementTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606863884</EngagementTypeUid>
                              <a:BillableFlag>true</a:BillableFlag>
                              <a:BusyFlag>true</a:BusyFlag>
                           </a:EngagementTypeDescriptor>
                        </a:EngagementDescriptor>
                        <a:ProjectCloseDate i:nil="true"/>
                        <a:ProjectDescription>New Web Services Project (A) - 2018</a:ProjectDescription>
                        <a:ProjectManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607112369</b:UserUid>
                           <b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
                           <b:FirstName>Jack</b:FirstName>
                           <b:LastName>Spratt</b:LastName>
                           <b:MiddleName i:nil="true"/>
                        </a:ProjectManager>
                        <a:ProjectName>New Web Services Project (A)</a:ProjectName>
                        <a:ProjectOpenDate>2018-01-01T00:00:00Z</a:ProjectOpenDate>
                        <a:ProjectStageIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ProjectStageId i:nil="true"/>
                           <b:ProjectStageName>Delivery</b:ProjectStageName>
                           <b:ProjectStageShortName>Delivery</b:ProjectStageShortName>
                           <b:ProjectStageUid>1152921504606853304</b:ProjectStageUid>
                        </a:ProjectStageIdentity>
                        <a:ColorMapBackgroundColor xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:B>255</b:B>
                           <b:G>255</b:G>
                           <b:R>0</b:R>
                        </a:ColorMapBackgroundColor>
                     </a:ProjectDescriptor>
                     <a:RoleEndDate i:nil="true"/>
                     <a:RoleName>JS</a:RoleName>
                     <a:RoleStartDate i:nil="true"/>
                  </a:PwsScheduleRole>
               </a:Roles>
               <a:ScheduleDates>
                  <a:PwsScheduleDate>
                     <a:Date>2018-03-28T00:00:00Z</a:Date>
                     <a:NormalWorkingMinutes>480</a:NormalWorkingMinutes>
                     <a:UtilizationBasisMinutes>480</a:UtilizationBasisMinutes>
                  </a:PwsScheduleDate>
                  <a:PwsScheduleDate>
                     <a:Date>2018-03-29T00:00:00Z</a:Date>
                     <a:NormalWorkingMinutes>480</a:NormalWorkingMinutes>
                     <a:UtilizationBasisMinutes>480</a:UtilizationBasisMinutes>
                  </a:PwsScheduleDate>
                  <a:PwsScheduleDate>
                     <a:Date>2018-03-30T00:00:00Z</a:Date>
                     <a:NormalWorkingMinutes>480</a:NormalWorkingMinutes>
                     <a:UtilizationBasisMinutes>0</a:UtilizationBasisMinutes>
                  </a:PwsScheduleDate>
                  <a:PwsScheduleDate>
                     <a:Date>2018-03-31T00:00:00Z</a:Date>
                     <a:NormalWorkingMinutes>0</a:NormalWorkingMinutes>
                     <a:UtilizationBasisMinutes>0</a:UtilizationBasisMinutes>
                  </a:PwsScheduleDate>
               </a:ScheduleDates>
               <a:TimeOff>
                  <a:PwsScheduleTimeOff>
                     <TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <TimeOffReasonName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Vacation</TimeOffReasonName>
                     <TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606858293</TimeOffReasonUid>
                     <a:TimeOffDates>
                        <a:PwsScheduleTimeOffDate>
                           <a:Date>2018-03-30T00:00:00Z</a:Date>
                           <a:TimeOffMinutes>1440</a:TimeOffMinutes>
                        </a:PwsScheduleTimeOffDate>
                     </a:TimeOffDates>
                  </a:PwsScheduleTimeOff>
               </a:TimeOff>
            </a:ResourceSchedule>
         </PwsGetResourceScheduleResult>
      </PwsGetResourceScheduleResponse>
   </s:Body>
</s:Envelope>

PwsGetResourceSchedule - Common Errors and Warnings

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.