Versions Compared

Version Old Version 15 New Version 16
Changes made by

Min Zeng

Bettina Borces

Saved on

Key

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

...

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 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 (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 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
<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>
            <!--Optional:-->
            <sch:QueryString>P00105</sch:QueryString>
            <!--Optional:-->
            <sch:LastUpdatedSinceTimestamp>2018-01-01z</sch:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      </pws:PwsGetProjectList>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsGetProjectList Response

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.


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


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

...