...
This web service retrieves the a document folder identity (PwsFolderRef) for a specified . Folders are containers for documents in Projectir, Documents in Projector can be attached to projects (workspace documents), project issues (issue attachments), resources (resumes), expense documents or cost cards (receipts), payment vouchers (payment voucher attachments) or invoices (uploaded invoices, supporting documents). You must specify the fodler type code and the identity of the expense document (PwsExpenseDocumentRef), invoice (PwsInvoiceRef), project (PwsProjectRef), project issue (PwsProjectIssueRef), resource (PwsResourceRef), user (PwsUserRef), cost card (PwsCostCardRef) or payment voucher (PwsPaymentVoucherRef) associated with the folder.
There are two additional folder types, the receipt pool folder and issue attachment pool folder that are used internally as a holding pen for receipts or issue attachments that have not yet been linked to an expense document/cost card or project issue respectively.
Once in possession of a folder identity, you can retrieve more detailed information about the folder, including the folder contents (see PwsGetFolderContents) or you can upload documents into the folder (please talk to Projector support).
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 | |
SessionTicket | String | Yes | Click here for more information. | AZZNMfO8vxeYuc3WXDkixw== | |
CreateIfNeededFlag | Boolean | No | false | If set to 'true', the folder will be created if it does not already exist. | false |
ExpenseDocumentIdentity | One of ExpenseDocumentIdentity, InvoiceIdentity, ProjectIdentity, ProjectIssueIdentity, ResourceIdentity, UserIdentity, CostCardIdentity or PaymentVoucherIdentity is required | The expense document identity, applicable if the FolderTypeCode = 'ExpenseReportFolder'. | |||
FolderTypeCode | String | Yes | The folder type code: 'ProjectWorkspaceFolder' for Project Workspace Folder 'ResourceResumeFolder' for Resource Resume Folder 'InvoiceFolder' for Invoice Folder 'ProjectIssueFolder' for Project Issue Folder 'ExpenseReportFolder' for Expense Report Folder 'UserReceiptPoolFolder' for a User's Receipt Folder 'UserIssueAttachmentPoolFolder' for User's Issue Attachment Pool Folder 'PaymentVoucherFolder' for Payment Voucher Folder | ExpenseReportFolder | |
InvoiceIdentity | See ExpenseDocumentIdentity | The invoice identity, applicable if the FolderTypeCode = 'InvoiceFolder'. | |||
ProjectIdentity | See ExpenseDocumentIdentity | The project identity, applicable if the FolderTypeCode = 'ProjectWorkspaceFolder'. | |||
ProjectIssueIdentity | See ExpenseDocumentIdentity | The project issue identity, applicable if the FolderTypeCode = 'ProjectIssueFolder'. | |||
ResourceIdentity | See ExpenseDocumentIdentity | The resource identity, applicable if the FolderTypeCode = 'ResourceResumeFolder'. | |||
UserIdentity | See ExpenseDocumentIdentity | The user identity, applicable if the FolderTypeCode = 'UserReceiptPoolFolder' or 'UserIssueAttachmentPoolFolder'. | |||
CostCardIdentity | See ExpenseDocumentIdentity | The cost card identity, applicable if the FolderTypeCode = 'ExpenseReportFolder'. | |||
PaymentVoucherIdentity | See ExpenseDocumentIdentity | The payment voucher identity, applicable if the FolderTypeCode = 'PaymentVoucherFolder'. |
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:PwsGetFolder>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AZZNMfO8vxeYuc3WXDkixw==</req:SessionTicket>
<doc:CreateIfNeededFlag>false</doc:CreateIfNeededFlag>
<doc:ExpenseDocumentIdentity>
<com:ExpenseDocumentUid>1152921504607683575</com:ExpenseDocumentUid>
</doc:ExpenseDocumentIdentity>
<doc:FolderTypeCode>ExpenseReportFolder</doc:FolderTypeCode>
</pws:serviceRequest>
</pws:PwsGetFolder>
</soapenv:Body>
</soapenv:Envelope> |
...