Versions Compared

Key

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

...

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

Request Format

Panel
titlePwsGetEngagement PwsGetProject Request


Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information

1

SessionTicket

String (50)

Yes


Click here for more information

AdmGqASTyugQuLJF8oZGkA==
EngagementIdentities
AW1yokY4MDImXfp9pM5NRw==
ModeString (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

One or more (up to 100) engagements to be retrieved

Request Usage Example(s)

...

languagexml
titleExample 01
collapsetrue


The details of the projects that are returned


Request Usage Example(s)

Code Block
languagexml
titleExample 01
collapsetrue
<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>
      <PwsGetEngagement><pws:PwsGetProject>
         <serviceRequest><pws:serviceRequest>
            <RequestId>1</RequestId><req:SessionTicket>AW1yokY4MDImXfp9pM5NRw==</req:SessionTicket>
            <SessionTicket>AdmGqASTyugQuLJF8oZGkA==</SessionTicket><sch:Mode>R</sch:Mode>
            <EngagementIdentities><sch:ProjectIdentities>
               <PwsEngagementRef><com:PwsProjectRef>
                  <EngagementCode>E001396</EngagementCode><com:ProjectCode>P001053-001</com:ProjectCode>
               </PwsEngagementRef>com:PwsProjectRef>
            </EngagementIdentities>sch:ProjectIdentities>
         </pws:serviceRequest>
      </pws:PwsGetProject>
   </soapenv:Body>
</PwsGetEngagement>soapenv:Envelope>


Response Format


Panel
titlePwsGetEngagement Response

...