Overview

This web service retrieves a list of engagement summary records (PwsEngagementSummary), based on specified search criteria. The following parameters affect the list of engagements retrieved:

QueryString. Find all engagements matching specified string in engagement name or engagement code, client name or code (for engagement's client and any of it's parent clients) or project name or code (for projects that are part of the engagement).
IncludeClosedFlag. If true, engagements that are open or closed according to the current engagement stage settings will be returned. Otherwise, only engagements that are not considered closed will be returned.
EngagementId/EngagementUid/EngagementCode. If specified, the identified engagement will be returned (QueryString and IncludeClosedFlag will be ignored).

Request Format

PwsGetProjectList Request

PwsGetProjectList
- serviceRequest: PwsGetProjectListRq
  - RequestId: Int32
  - SessionTicket: String
  - IncludeClosedFlag: Boolean
  - MaxRowsToReturn: Int32
  - ProjectIdentity: PwsProjectRef
  - QueryString: String
  - LastUpdatedSinceTimestamp: DateTime

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.
SessionTicket	String	Yes		Click here for more information.
IncludeClosedFlag	Boolean	No (???)	false	If set to 'true', projects that are open or closed according to the project stage settings will be returned. Otherwise, only projects that are considered not closed will be returned. This flag is disregarded if a project is specified in ProjectIdentity.	false
MaxRowsToReturn	Int32	No		The maximum number of projects to be retrieved. This flag is disregarded if a project is specified in ProjectIdentity.	10
ProjectIdentity	PwsProjectRef	No		The unique keys used to identify projects(s) to be retrieved. Click here for more information.
QueryString	String	No		A search string to narrow down the results. A project will be included in the results if the search string matches the project's code or name, or if it matches the client name or number for the engagement's client or any parent client thereof, or if it matches the contract line item name or code or project name or code of any contract line item or project contained in the engagement. This value is disregarded if a project is specified in ProjectIdentity.	P001053-001\|P001053-002
LastUpdatedSinceTimestamp	DateTime	No		Only projects that have been updated on or after the specified date/time will be retrieved. This value is disregarded if a project is specified in ProjectIdentity.	2018-01-01z

Request Usage Example(s)

Example 01 - Project is not specified

Example 02 - Project is specified

<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:PwsGetProjectList>
         <pws:serviceRequest>
            <req:SessionTicket>ARM5cmQi4CD5BoGl6bHk4w==</req:SessionTicket>
            <!--sch:IncludeClosedFlag>false</sch:IncludeClosedFlag-->
            <sch:MaxRowsToReturn>2</sch:MaxRowsToReturn>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001053-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <!--Optional:-->
            <sch:QueryString>P00105</sch:QueryString>
            <!--Optional:-->
            <sch:LastUpdatedSinceTimestamp>2018-01-01z</sch:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      </pws:PwsGetProjectList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetEngagementList Response

PwsGetEngagementListResponse
- PwsGetEngagementListResult: PwsGetEngagementListRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Engagements: PwsEngagementSummary [0..infinity]

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-01-19T16:51:13.0252909Z
Engagements	PwsEngagementSummary [0..infinity]	The engagement summary records that were fetched by the service

Response Usage Example(s)

Example 02 - Project is specified

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectListResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-01T15:58:02.3232587Z</ServerTimestampUtc>
            <a:Projects xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsProjectSummary>
                  <b:ProjectCode>P001053-002</b:ProjectCode>
                  <b:ProjectId i:nil="true"/>
                  <b:ProjectUid>1152921504607411721</b:ProjectUid>
                  <b:EngagementIdentity>
                     <b:EngagementCode>P001052</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <b:EngagementUid>1152921504607090183</b:EngagementUid>
                  </b:EngagementIdentity>
                  <b:ProjectName>Created via PwsSaveProject</b:ProjectName>
               </b:PwsProjectSummary>
            </a:Projects>
         </PwsGetProjectListResult>
      </PwsGetProjectListResponse>
   </s:Body>
</s:Envelope>

PwsGetEngagementList - Common Errors and Warnings

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

ErrorNumber	ErrorCode	Description
54282	ProjectNotFound	Specified project does not exist.