Versions Compared

Key

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

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

AQ2QHlYPIcig+lUEf1cCYw==

DeletePermanentlyFlag

Boolean

No

false

If set to 'true', the document will be permanently deleted and, will not be retrievable via Projector's "show deleted documents" / "undo" option.

true

DocumentIdentity

PwsDocumentRef

Yes


This is the identity of the document to be deleted


OverrideLockFlag

Boolean

No

false

If set to 'true', an existing lock on the document will be deleted even if it is locked / checked out by another usernot prevent it from being deleted.

false

Request Usage Example(s)

...

Panel
titlePwsDeleteDocument Response

...

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-02-05T19:17:05.4567739Z

DocumentCount

Int32

This is the number of documents that remain within the same folder from which the specified document was deleted

1

NoteCount

Int32

This is the number of notes that remain within the same folder from which the specified document was deleted. This applies to expense document attachments (receipts) only.

0

Response Usage Example(s)

...