Versions Compared

Key

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

...

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

  • QueryString. : Find all engagements projects matching specified string in engagement name or engagement code, in project's code or name, associated contract line item code or name, the associated engagement code or name, or the client name or code (number for the associated engagement's client and or any of it's parent clients) or project name or code (for projects that are part of the engagement)parent client thereof.
  • IncludeClosedFlag. If set to 'true', engagements projects that are open or considered closed according to the current engagement project stage settings will be returnedincluded in the results. Otherwise, only engagements projects that are not considered closed open will be returned.EngagementId/EngagementUid/EngagementCode. included.
  • LastUpdatedTimestamp: If specified, only projects updated on after the specified timestamp will be included.
  • ProjectIdentity: If specified, only the identified engagement project will be returned (. QueryString, IncludeClosedFlag and IncludeClosedFlag LastUpdatedTimestamp will be ignored).

Request Format


Panel
titlePwsGetProjectList Request

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

open or

considered closed according to the project stage settings will be

returned

included. Otherwise, only projects that are considered

not closed

open will be

returned

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

flag

value is disregarded if a project is specified in ProjectIdentity.

 10

ProjectIdentity

PwsProjectRef

 No

 

The unique keys used to identify projects(s) to be retrieved


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

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


Code Block
languagexml
titleExample 01 - Project is not specified
collapsetrue
Code Block
languagexml
titleExample 02 - Project is specified
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>
      <pws:PwsGetProjectList>
         <pws:serviceRequest>
            <req:SessionTicket>ARM5cmQi4CD5BoGl6bHk4w==</req:SessionTicket>
            <!--sch:IncludeClosedFlag>false<<sch:IncludeClosedFlag>true</sch:IncludeClosedFlag-->IncludeClosedFlag>
            <sch:MaxRowsToReturn>2</sch:MaxRowsToReturn>
            <sch:ProjectIdentity>QueryString>P00105</sch:QueryString>
            <sch:LastUpdatedSinceTimestamp>2018-01-01z</sch:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
     <com:ProjectCode>P001053-001</com:ProjectCode>  </pws:PwsGetProjectList>
   </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleExample 02 - Project is specified
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>
      <pws:PwsGetProjectList>
         <pws:serviceRequest>
            <req:SessionTicket>ARM5cmQi4CD5BoGl6bHk4w==</req:SessionTicket>
            <sch:MaxRowsToReturn>2</sch:MaxRowsToReturn>
            <sch:ProjectIdentity>
               <!--Optional:--><com:ProjectCode>P001053-001</com:ProjectCode>
            <sch:QueryString>P00105<</sch:QueryString>ProjectIdentity>
            <!--Optional:--><sch:QueryString>P00105</sch:QueryString>
            <sch:LastUpdatedSinceTimestamp>2018-01-01z</sch:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      </pws:PwsGetProjectList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsGetEngagementList PwsGetProjectList Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message.

Click

Click here

for

 for more information.


ResponseId

Int32

Click here for more information.

1


StatusRequestStatus
Click
Click here
for
 for more information
.
Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018

 2018-

01

02-

19T16

01T18:

51

08:

13

41.

0252909Z

8772809Z

Engagements

Projects

PwsEngagementSummary

PwsProjectSummary[

0..infinity

]

The

engagement

project summary records that were fetched by the service. Click here for more information.


Response Usage Example(s)

...

Code Block
languagexml
titleExample 01 - Project is not specified with error code
collapsetrue
<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>


Code Block
languagexml
titleExample 02 - Project is specified
collapsetrue
<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>

...

PwsGetProjectList - Common Errors and Warnings

ErrorNumber

ErrorCode

Description

104RowCountExceeded

Not all data rows were returned by this request because the specified row count was smaller than the total number of rows available.

54282

ProjectNotFound

Specified project does not exist.

...