Overview

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

QueryString: Find all projects matching specified string in project's code or name, associated contract line item code or name, the associated engagement code or name, or the client name or number for the associated engagement's client or any parent client thereof.
IncludeClosedFlag: If set to 'true', projects that are considered closed according to the project stage settings will be included in the results. Otherwise, only projects that are considered open will be included.
LastUpdatedTimestamp: If specified, only projects updated on after the specified timestamp will be included.
ProjectIdentity: If specified, only the identified project will be returned. QueryString, IncludeClosedFlag and LastUpdatedTimestamp will be ignored.

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

PwsGetProjectList Request

PwsGetProjectList
- serviceRequest: PwsGetProjectListRq
  - RequestId: Int32
  - SessionTicket: String
  - IncludeClosedFlag: Boolean
  - MaxRowsToReturn: Int32
  - ProjectIdentity: PwsProjectRef
  - QueryString: String (255)
  - 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.	ARM5cmQi4CD5BoGl6bHk4w==
IncludeClosedFlag	Boolean	No	false	If set to 'true', projects that are considered closed according to the project stage settings will be included. Otherwise, only projects that are considered open will be included. This flag is disregarded if a project is specified in ProjectIdentity.	false
MaxRowsToReturn	Int32	No		The maximum number of projects to be retrieved. This value is disregarded if a project is specified in ProjectIdentity.	10
ProjectIdentity	PwsProjectRef	No		May be specified to retrieve a single project summary. Click here for more information.
QueryString	String (255)	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, of if it matches the associated contract line item code or name, or if it matches the associated engagement code or name, of if it matches the client name or number for the associated engagement's client or any parent client thereof. This value is disregarded if a project is specified in ProjectIdentity.	P001053-001\|P001053-002
LastUpdatedSinceTimestamp	DateTime	No		Only projects that have been updated 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

<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>true</sch:IncludeClosedFlag>
            <sch:MaxRowsToReturn>2</sch:MaxRowsToReturn>
            <sch:QueryString>P00105</sch:QueryString>
            <sch:LastUpdatedSinceTimestamp>2018-01-01z</sch:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      </pws:PwsGetProjectList>
   </soapenv:Body>
</soapenv:Envelope>

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:MaxRowsToReturn>2</sch:MaxRowsToReturn>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001053-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <sch:QueryString>P00105</sch:QueryString>
            <sch:LastUpdatedSinceTimestamp>2018-01-01z</sch:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      </pws:PwsGetProjectList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetProjectList Response

PwsGetProjectListResponse
- PwsGetProjectListResult: PwsGetProjectListRs
  - Messages: PwsMessage []
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Projects: PwsProjectSummary []

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.
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-02-01T18:08:41.8772809Z
Projects	PwsProjectSummary []	The project summary records that were fetched by the service. Click here for more information.

Response Usage Example(s)

Example 01 - Project is not specified with error code

<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/">
               <b:PwsMessage>
                  <b:AdditionalErrorText>Warning 104: {oldestSurvivingTimeCardWorkDateString}</b:AdditionalErrorText>
                  <b:ErrorCode>RowCountExceeded</b:ErrorCode>
                  <b:ErrorNumber>104</b:ErrorNumber>
                  <b:ErrorText>Not all data rows were returned by this request because the specified row count was smaller than the total number of rows available.</b:ErrorText>
                  <b:Type>Warning</b:Type>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-01T18:08:41.8772809Z</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>
               <b:PwsProjectSummary>
                  <b:ProjectCode>P001053-WS1</b:ProjectCode>
                  <b:ProjectId i:nil="true"/>
                  <b:ProjectUid>1152921504607411806</b:ProjectUid>
                  <b:EngagementIdentity>
                     <b:EngagementCode>P001053</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <b:EngagementUid>1152921504607090526</b:EngagementUid>
                  </b:EngagementIdentity>
                  <b:ProjectName>Updated using PwsSaveProject</b:ProjectName>
               </b:PwsProjectSummary>
            </a:Projects>
         </PwsGetProjectListResult>
      </PwsGetProjectListResponse>
   </s:Body>
</s:Envelope>