...
Element | Data Type | Required? | Default | Description | Sample Data | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | |||||||||
SessionTicket | String | Yes | Click here for more information. | |||||||||
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. | |||||||||
ProjectIdentity | 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 | 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 | 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. | ResourceIdentity | SearchString | String (255) | IncludeInactiveFlag | Boolean | false |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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>
<doc:IncludeInactiveFlag>true</doc:IncludeInactiveFlag>
</pws:serviceRequest>
</pws:PwsSearchDocuments>
</soapenv:Body>
</soapenv:Envelope> |
...