Versions Compared

Key

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

...

This web service deletes a specified document (PwsDocumentRef). The service will return the identity of the deleted client (PwsClientRef).

Request Format


Panel
titlePwsDeleteDocument Request

...

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</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:OverrideLockFlag>false</doc:OverrideLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsDeleteDocument Response

Response Elements


Element

Data Type

Default

Description

Sample Data

Messages

PwsMessage

 

 

 

ResponseId

Int32

 

Click here for more information.

 

Status

RequestStatus

 

Click here for more information.

 

ServerTimestampUtc

DateTime

 

Click here for more information.

 

DocumentCount

Int32

 

 

 

NoteCount

Int32

 

 

 

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</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-05T18:46:19.5982087Z</ServerTimestampUtc>
            <a:DocumentCount>0</a:DocumentCount>
            <a:NoteCount>0</a:NoteCount>
         </PwsDeleteDocumentResult>
      </PwsDeleteDocumentResponse>
   </s:Body>
</s:Envelope>