...
This web service deletes a specified document (PwsDocumentRef). The service will return the identity of the deleted client (PwsClientRef).
Request Format
| Panel | ||
|---|---|---|
| ||
|
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. |
AQ2QHlYPIcig+lUEf1cCYw== | |
DeletePermanentlyFlag | Boolean |
No |
DocumentIdentity
OverrideLockFlag
Boolean
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 | 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 not prevent it from being deleted. | 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:PwsDeleteDocument>
<pws:serviceRequest>
<req:SessionTicket>AQ2QHlYPIcig+lUEf1cCYw==</req:SessionTicket>
<doc:DeletePermanentlyFlag>true</doc:DeletePermanentlyFlag>
<doc:DocumentIdentity>
<com:DocumentRefUid>1152921504607571566</com:DocumentRefUid>
</doc:DocumentIdentity>
<doc:OverrideLockFlag>false</doc:OverrideLockFlag>
</pws:serviceRequest>
</pws:PwsDeleteDocument>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information | 0 |
Status | 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)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsDeleteDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsDeleteDocumentResult 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-02-05T19:17:05.4567739Z</ServerTimestampUtc>
<a:DocumentCount>1</a:DocumentCount>
<a:NoteCount>0</a:NoteCount>
</PwsDeleteDocumentResult>
</PwsDeleteDocumentResponse>
</s:Body>
</s:Envelope> |
PwsDeleteDocument - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10104 | InternalError | Error 75023, State 1: Document cannot be deleted because the document is locked |
| 75085 | DocumentViewPermissionDenied | You do not have permission to view this document or folder. |
75086 | DocumentUpdatePermissionDenied | You do not have permission to update this document or folder. |
| 75197 | DocumentRefInvalid | DocumentRef is required. |
| 75199 | DocumentNotFound | Document not found. |
| 75200 | DocumentVersionRefInvalid | DocumentVersionRef is required. |
| 75202 | DocumentVersionNotFound | Document version not found. |