Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview

This web service allows user to search for projects or a single project.  

Request Format

PwsSearchProjects Request
  • PwsSearchProjects
    • serviceRequest: PwsSearchProjectsRq

Request Elements

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32



Click here for more information.


SessionTicket

String



Click here for more information.


AvailableProjectsOnlyFlag

Boolean





EndDate

DateTime





ListType

String





MaximumRows

Int32





MruFlag

Boolean





ProjectIdentity

PwsProjectRef





ResourceIdentity

PwsResourceRef





SearchString

String





StartDate

DateTime





ProjectIdentities

PwsProjectRef[???]





DocumentType

String





Request Usage Example(s)

Example 01 - with project identity 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSearchProjects>
         <pws:serviceRequest>
            <req:SessionTicket>AYnZTqq32MHctd+MESbzaQ==</req:SessionTicket>
            <tim:AvailableProjectsOnlyFlag>false</tim:AvailableProjectsOnlyFlag>
            <tim:EndDate>2018-03-31z</tim:EndDate>
            <tim:ListType>T</tim:ListType>
            <tim:MaximumRows>10</tim:MaximumRows>
            <tim:ProjectIdentity>
               <com:ProjectCode>P001053-001</com:ProjectCode>
            </tim:ProjectIdentity>
            <tim:ResourceIdentity>
               <com:ResourceDisplayName>Barry Allen</com:ResourceDisplayName>
            </tim:ResourceIdentity>
            <tim:SearchString></tim:SearchString>
            <tim:StartDate>2018-01-01z</tim:StartDate>
            <tim:DocumentType></tim:DocumentType>
         </pws:serviceRequest>
      </pws:PwsSearchProjects>
   </soapenv:Body>
</soapenv:Envelope>
Example 02 - without project identity 
</soapenv:Envelope>

Response Format

PwsSearchProjects Response

Response Elements

Element

Data Type

Description

Sample Data

Messages

PwsMessage



ResponseId

Int32

Click here for more information.


Status

RequestStatus

Click here for more information


ServerTimestampUtc

DateTime

Click here for more information.


Projects

PwsProjectDescriptor



Response Usage Example(s)

Example 01 - with project identity 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSearchProjectsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSearchProjectsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" 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-03-26T13:42:16.9794797Z</ServerTimestampUtc>
            <a:Projects>
               <a:PwsProjectDescriptor>
                  <ProjectCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">P001053-001</ProjectCode>
                  <ProjectId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <ProjectUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607413582</ProjectUid>
                  <a:EngagementDescriptor>
                     <EngagementCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">P001053</EngagementCode>
                     <EngagementId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <EngagementUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607328540</EngagementUid>
                     <a:ClientDescriptor>
                        <ClientId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <ClientNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">C000111</ClientNumber>
                        <ClientUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606906284</ClientUid>
                        <a:ClientName>Metro Opera</a:ClientName>
                        <a:ParentClientDescriptor i:nil="true"/>
                     </a:ClientDescriptor>
                     <a:EngagementManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Ronni Skerker</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>030</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944264</b:UserUid>
                        <b:EmailAddress>Ronni@revcorp.doc</b:EmailAddress>
                        <b:FirstName>Ronni</b:FirstName>
                        <b:LastName>Skerker</b:LastName>
                        <b:MiddleName i:nil="true"/>
                     </a:EngagementManager>
                     <a:EngagementName>Parsifal</a:EngagementName>
                     <a:EngagementTypeDescriptor>
                        <EngagementTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <EngagementTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Billable - Time &amp; Materials</EngagementTypeName>
                        <EngagementTypeShortName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T&amp;M</EngagementTypeShortName>
                        <EngagementTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606858165</EngagementTypeUid>
                        <a:BillableFlag>true</a:BillableFlag>
                     </a:EngagementTypeDescriptor>
                     <a:EngagementCurrencyDecimalDigits>2</a:EngagementCurrencyDecimalDigits>
                     <a:EngagementCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:CurrencyCode>USD</b:CurrencyCode>
                        <b:CurrencyId i:nil="true"/>
                        <b:CurrencyUid>1152921504606849879</b:CurrencyUid>
                     </a:EngagementCurrencyIdentity>
                  </a:EngagementDescriptor>
                  <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:LocationId i:nil="true"/>
                     <b:LocationName>London</b:LocationName>
                     <b:LocationUid>1152921504606850976</b:LocationUid>
                  </a:LocationIdentity>
                  <a:ProjectCloseDate>2019-07-27T00:00:00Z</a:ProjectCloseDate>
                  <a:ProjectDescription>Updated scription from web service</a:ProjectDescription>
                  <a:ProjectManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Larry Krakauer</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606944254</b:UserUid>
                     <b:EmailAddress>Larry@revcorp.doc</b:EmailAddress>
                     <b:FirstName>Larry</b:FirstName>
                     <b:LastName>Krakauer</b:LastName>
                     <b:MiddleName>A</b:MiddleName>
                  </a:ProjectManager>
                  <a:ProjectName>Parsifal</a:ProjectName>
                  <a:ProjectOpenDate>2011-01-01T00:00:00Z</a:ProjectOpenDate>
                  <a:ProjectRoles/>
                  <a:ProjectStageIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ProjectStageId i:nil="true"/>
                     <b:ProjectStageName>Delivery</b:ProjectStageName>
                     <b:ProjectStageShortName>Delivery</b:ProjectStageShortName>
                     <b:ProjectStageUid>1152921504606849646</b:ProjectStageUid>
                  </a:ProjectStageIdentity>
                  <a:UnavailableReasonCode i:nil="true"/>
                  <a:Udf1InactiveFlag>false</a:Udf1InactiveFlag>
                  <a:Udf1Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                  <a:Udf2InactiveFlag>false</a:Udf2InactiveFlag>
                  <a:Udf2Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                     <b:string>1 very good</b:string>
                     <b:string>2 not bad</b:string>
                     <b:string>3 so so</b:string>
                     <b:string>4 bad</b:string>
                  </a:Udf2Values>
                  <a:Udf1DefaultValue i:nil="true"/>
                  <a:Udf2DefaultValue i:nil="true"/>
                  <a:ExpenseTypeIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               </a:PwsProjectDescriptor>
            </a:Projects>
         </PwsSearchProjectsResult>
      </PwsSearchProjectsResponse>
   </s:Body>
</s:Envelope>
Example 02 - without project identity 
</soapenv:Envelope>


Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

64223InvalidValueForListTypeThe specified value for ListType is invalid. Valid values are T for time or C for cost.
  • No labels