Versions Compared

Key

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

Overview


This web service retrieves the document folder identity (PwsFolderRef) for a specified expense document (PwsExpenseDocumentRef), invoice (PwsInvoiceRef), project (PwsProjectRef), project issue (PwsProjectIssueRef), resource (PwsResourceRef), user (PwsUserRef), cost card (PwsCostCardRef) or payment voucher (PwsPaymentVoucherRef).

Request Format


Panel
titlePwsGetFolder Request

...

Panel
titlePwsGetFolder 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

1

Status

RequestStatus

Click here for more information

Ok 

ServerTimestampUtc

DateTime

Click here for more information

2018-03-16T17:07:24.3032414Z

FolderIdentity

PwsFolderRef

The document folder identity

 


Response Usage Example(s)

...


ErrorNumber

ErrorCode

ErrorText

21000FolderTypeCodeRequiredForGetFolderA folder type code must be specified.
21017InvalidValueForFolderTypeCodeThe specified folder type code is not recognized.
54279ProjectReferenceInvalidA specified project identity was incomplete. Each project identity must specify either a project id, a project uid or a project code.
54282ProjectNotFoundSpecified project does not exist.
54833ProjectIssueNotFoundProject issue not found.
57545ResourceNotFoundThe specified resource does not exist.
57551UserNotFoundSpecified user does not exist.
65491CostCardNotFoundCostCard not found.
65499PaymentVoucherNotFoundPayment voucher not found.
68199InvoiceNotFoundInvoice not found.