Overview

This web service allows user to search for resource resumes and documents in project workspace. By specifying folder type code and providing the necessary project identity or resource identity, the search returns project workspace documents or resource resumes.

Request Format

PwsSearchDocuments Request

PwsSearchDocuments
- serviceRequest: PwsSearchDocumentsRq
  - RequestId: Int32
  - SessionTicket: String
  - FolderTypeCode: String (30)
  - ProjectIdentity: PwsProjectRef
  - ResourceIdentity: PwsResourceRef
  - SearchString: String (255)
  - IncludeInactiveFlag: Boolean

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.	AftyRXSTlnMPzozuKwq0kQ==
FolderTypeCode	String (30)	Yes		The code for the documents' folder type. Only two values are allowed and they are "ProjectWorkspaceFolder" for document search and "ResourceResumeFolder" for resume search.	ProjectWorkspaceFolder
ProjectIdentity	PwsProjectRef	Yes if searching for project workspace documents		This is the identity of a project and must be included if folder is "ProjectWorkspaceFolder". Click here for more information.
ResourceIdentity	PwsResourceRef	Yes if searching for resource resume		This is the identity of a resource and must be included if folder is "ResourceResumeFolder". Click here for more information.
SearchString	String (255)	Yes		A search string to narrow down the results. A document will be included in the results if the search string matches the word(s) in the document.	Nabucco
IncludeInactiveFlag	Boolean	No	false	Applies to resume search with folder type "ResourceResumeFolder". If set to 'true', resumes from inactive resources are also included.	false

Request Usage Example(s)

Example 01 - project workspace document

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:doc="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSearchDocuments>
         <pws:serviceRequest>
            <req:SessionTicket>AftyRXSTlnMPzozuKwq0kQ==</req:SessionTicket>
            <doc:FolderTypeCode>ProjectWorkspaceFolder</doc:FolderTypeCode>
            <doc:ProjectIdentity>
               <com:ProjectCode>P001053-001</com:ProjectCode>
            </doc:ProjectIdentity>
            <doc:SearchString>nabucco</doc:SearchString>           
         </pws:serviceRequest>
      </pws:PwsSearchDocuments>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - resource resume

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:doc="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSearchDocuments>
         <pws:serviceRequest>
            <req:SessionTicket>AYN347z7HGXMoktz5O85hQ==</req:SessionTicket>
            <doc:FolderTypeCode>ResourceResumeFolder</doc:FolderTypeCode>
            <doc:ResourceIdentity>
               <com:ResourceDisplayName>Barry Allen</com:ResourceDisplayName>
            </doc:ResourceIdentity>
            <doc:SearchString>Bachelor</doc:SearchString>
            <doc:IncludeInactiveFlag>true</doc:IncludeInactiveFlag>
         </pws:serviceRequest>
      </pws:PwsSearchDocuments>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSearchDocuments Response

PwsSearchDocumentsResponse
- PwsSearchDocumentsResult: PwsSearchDocumentsRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Results: PwsSearchResult

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.	0
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-03-21T14:45:52.6954441Z
Results	PwsSearchResult	The list of documents that satisfies the search criteria. Click here for more information.

Response Usage Example(s)

Example 01 - project workspace document

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSearchDocumentsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSearchDocumentsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" 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-21T14:45:52.6954441Z</ServerTimestampUtc>
            <a:Results>
               <a:PwsSearchResult>
                  <a:Document>
                     <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607656365</DocumentRefUid>
                     <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606950320</b:UserUid>
                     </a:CreatedByUserIdentity>
                     <a:CreatedTimestamp>2018-03-21T14:45:10.663Z</a:CreatedTimestamp>
                     <a:CurrentVersion>
                        <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607660649</DocumentVersionUid>
                        <a:Comments i:nil="true"/>
                        <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                           <b:UserUid>1152921504606950320</b:UserUid>
                        </a:CreatedByUserIdentity>
                        <a:CreatedTimestamp>2018-03-21T14:45:10.663Z</a:CreatedTimestamp>
                        <a:DocumentArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:VersionNumber>1</a:VersionNumber>
                     </a:CurrentVersion>
                     <a:DeletedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:DeletedTimestamp i:nil="true"/>
                     <a:DocumentName>milan blog1.rtf</a:DocumentName>
                     <a:DocumentSize>48303</a:DocumentSize>
                     <a:DocumentUri i:nil="true"/>
                     <a:LockedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:LockedTimestamp i:nil="true"/>
                     <a:MimeType>application/rtf</a:MimeType>
                     <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606950320</b:UserUid>
                     </a:ModifiedByUserIdentity>
                     <a:ModifiedTimestamp>2018-03-21T14:45:10.663Z</a:ModifiedTimestamp>
                     <a:SupportPreviewFlag>false</a:SupportPreviewFlag>
                     <a:SupportThumbnailFlag>false</a:SupportThumbnailFlag>
                     <a:DocumentData>
                        <a:DataItems/>
                        <a:DocumentDataDetail>
                           <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:ItemId i:nil="true"/>
                              <b:ItemType>P</b:ItemType>
                              <b:ItemUid>1152921504607413582</b:ItemUid>
                              <b:ReferenceType i:nil="true"/>
                           </a:AssociatedItemIdentity>
                           <a:Associations/>
                           <a:Notes i:nil="true"/>
                        </a:DocumentDataDetail>
                     </a:DocumentData>
                     <a:EditDeleteFlag>false</a:EditDeleteFlag>
                     <a:NumberPages i:nil="true"/>
                     <a:ArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:EditDeletePermissionFlag>false</a:EditDeletePermissionFlag>
                     <a:ReceiptLockedFlag>false</a:ReceiptLockedFlag>
                  </a:Document>
                  <a:Filename>e:\ProjectorDocs1\3018\docs\89\doc_809389_813673.rtf</a:Filename>
                  <a:Score>100</a:Score>
                  <a:Synopsis>Teatro Alla Scala, opening night for Verdi's [{[{Nabucco}]}], tearing up when the famous chorus piece "Va</a:Synopsis>
               </a:PwsSearchResult>
            </a:Results>
         </PwsSearchDocumentsResult>
      </PwsSearchDocumentsResponse>
   </s:Body>
</s:Envelope>

Example 02 - resource resume

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSearchDocumentsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSearchDocumentsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" 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-21T15:29:36.1521462Z</ServerTimestampUtc>
            <a:Results>
               <a:PwsSearchResult>
                  <a:Document>
                     <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607656377</DocumentRefUid>
                     <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944261</b:UserUid>
                     </a:CreatedByUserIdentity>
                     <a:CreatedTimestamp>2018-03-21T15:28:01.82Z</a:CreatedTimestamp>
                     <a:CurrentVersion>
                        <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607660661</DocumentVersionUid>
                        <a:Comments i:nil="true"/>
                        <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                           <b:UserUid>1152921504606944261</b:UserUid>
                        </a:CreatedByUserIdentity>
                        <a:CreatedTimestamp>2018-03-21T15:28:01.82Z</a:CreatedTimestamp>
                        <a:DocumentArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:VersionNumber>1</a:VersionNumber>
                     </a:CurrentVersion>
                     <a:DeletedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:DeletedTimestamp i:nil="true"/>
                     <a:DocumentName>Barry Allen resume.docx</a:DocumentName>
                     <a:DocumentSize>15563</a:DocumentSize>
                     <a:DocumentUri i:nil="true"/>
                     <a:LockedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:LockedTimestamp i:nil="true"/>
                     <a:MimeType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</a:MimeType>
                     <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944261</b:UserUid>
                     </a:ModifiedByUserIdentity>
                     <a:ModifiedTimestamp>2018-03-21T15:28:01.82Z</a:ModifiedTimestamp>
                     <a:SupportPreviewFlag>false</a:SupportPreviewFlag>
                     <a:SupportThumbnailFlag>false</a:SupportThumbnailFlag>
                     <a:DocumentData>
                        <a:DataItems/>
                        <a:DocumentDataDetail>
                           <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:ItemId i:nil="true"/>
                              <b:ItemType>R</b:ItemType>
                              <b:ItemUid>1152921504607019493</b:ItemUid>
                              <b:ReferenceType i:nil="true"/>
                           </a:AssociatedItemIdentity>
                           <a:Associations/>
                           <a:Notes i:nil="true"/>
                        </a:DocumentDataDetail>
                     </a:DocumentData>
                     <a:EditDeleteFlag>false</a:EditDeleteFlag>
                     <a:NumberPages i:nil="true"/>
                     <a:ArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:EditDeletePermissionFlag>false</a:EditDeletePermissionFlag>
                     <a:ReceiptLockedFlag>false</a:ReceiptLockedFlag>
                  </a:Document>
                  <a:Filename>e:\ProjectorDocs1\3018\docs\01\doc_809401_813685.docx</a:Filename>
                  <a:Score>100</a:Score>
                  <a:Synopsis>consistently exceed expectations. Education ABC UNIVERSITY - Sometown, NH [{[{Bachelor}]}] of Science, Major in Information Technology Program, Currently</a:Synopsis>
               </a:PwsSearchResult>
            </a:Results>
         </PwsSearchDocumentsResult>
      </PwsSearchDocumentsResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
21017	InvalidValueForFolderTypeCode	The specified folder type code is not recognized.
21030	SearchStringRequiredForSearchDocuments	A search string must be specified.
75240	ResourceMayNotBeSpecifiedWhenSearchingWorkspaces	Resource may not be specified when searching project workspaces.
75241	ProjectmayNotBeSpecifiedWhenSearchingResumes	Project may not be specified when searching resource resumes.