Versions Compared

Key

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

...

Panel
titlePwsDeleteDocument Request

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

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 not prevent it from being deleted.

false

Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<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>1152921504607571565<DocumentRefUid>1152921504607571566</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:OverrideLockFlag>false</doc:OverrideLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteDocument>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsDeleteDocument Response

Response Elements


Element

Data Type

Default

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

NoteCount

Int32

 

 

 

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
languagexml
titleExample 01
collapsetrue
<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/">1<>0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-05T1805T19:4617:1905.5982087Z<4567739Z</ServerTimestampUtc>
            <a:DocumentCount>0<DocumentCount>1</a:DocumentCount>
            <a:NoteCount>0</a:NoteCount>
         </PwsDeleteDocumentResult>
      </PwsDeleteDocumentResponse>
   </s:Body>
</s:Envelope>

PwsDeleteDocument - Common Errors and Warnings


ErrorNumberErrorCodeErrorText
10104InternalErrorError 75023, State 1: Document cannot be deleted because the document is locked
75085DocumentViewPermissionDeniedYou do not have permission to view this document or folder.

75086

DocumentUpdatePermissionDeniedYou do not have permission to update this document or folder.
75197DocumentRefInvalidDocumentRef is required.
75199DocumentNotFoundDocument not found.
75200DocumentVersionRefInvalidDocumentVersionRef is required.
75202DocumentVersionNotFoundDocument version not found.