Overview

This web service retrieves a list of engagement element records (PwsEngagementElement), based upon a list of unique engagement identifiers (PwsEngagementRef).

Request Format

PwsGetProject Request

PwsGetProject
- serviceRequest: PwsGetProjectRq
  - RequestId: Int32
  - SessionTicket: String
  - Mode: String
  - ProjectIdentities: PwsProjectRef[1..100]

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information	1
SessionTicket	String (50)	Yes	Click here for more information	AW1yokY4MDImXfp9pM5NRw==
Mode	String (1)	Yes	The mode determines the hours returned in response. If set to "R", requested hours; "A", booked hours; and "E" effective hours (requested hours for requested roles and booked hours for booked roles).	R/A/E
ProjectIdentities	PwsEngagementRef [1..100]	Yes	The details of the projects that are returned

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:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetProject>
         <pws:serviceRequest>
            <req:SessionTicket>AW1yokY4MDImXfp9pM5NRw==</req:SessionTicket>
            <sch:Mode>R</sch:Mode>
            <sch:ProjectIdentities>
               <com:PwsProjectRef>
                  <com:ProjectCode>P001053-001</com:ProjectCode>
               </com:PwsProjectRef>
            </sch:ProjectIdentities>
         </pws:serviceRequest>
      </pws:PwsGetProject>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetProject Response

PwsGetProjectResponse
- PwsGetProjectResult: PwsGetProjectRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Projects: PwsProjectElement

Response Elements

Element	Data Type	Description
RequestId	Int32	Click here for more information.
SessionTicket	String	Click here for more information.
Mode	String
ProjectIdentities	PwsProjectRef

Response Usage Example(s)

Example 01 - Single Engagement

PwsGetEngagement - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
105	AtLeastOneItemNotFound	One or more specified engagements not found
12042	NoEngagementsSpecified	No engagements specified for retrieval
12044	MaximumEngagementIdentitiesExceeded	Attempt to retrieve more than the maximum allowable number of engagements at once
50045	ViewPermissionDenied	Permission denied
54059	EngagementNotSpecified	A specified engagement reference was incomplete or missing
54064	UnexpectedErrorRetrievingEngagements	Unexpected error retrieving engagements
54370	NoPermissionToViewEngagement	Permission denied to view specific engagement