Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


This web service deletes a version (PwsDocumentVersionRef) of a specified document (PwsDocumentRef).

Request Format


PwsDeleteDocumentVersion 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.

 

DocumentIdentity

PwsDocumentRef

Yes 

 

This is the identity of the document to be deleted 

 

DocumentVersionIdentity

PwsDocumentVersionRef

Yes 

 

This is the identity of the document version to be deleted 

 

OverrideLockFlag

Boolean

No 

false

If set to 'true', the document will be deleted even if it is locked / checked out by another user 

 

Request Usage Example(s)


Example 01 
<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:PwsDeleteDocumentVersion>
         <pws:serviceRequest>
            <req:SessionTicket>AW1UpKK1eVCbgfEayQrXEA==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607571571</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:DocumentVersionIdentity>
               <com:DocumentVersionUid>1152921504607572664</com:DocumentVersionUid>
            </doc:DocumentVersionIdentity>
            <doc:OverrideLockFlag>true</doc:OverrideLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteDocumentVersion>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsDeleteDocumentVersion 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

0

Status

RequestStatus

Click here for more information

Ok 

ServerTimestampUtc

DateTime

Click here for more information

2018-02-05T20:08:05.1331353Z 

Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteDocumentVersionResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteDocumentVersionResult 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-05T20:08:05.1331353Z</ServerTimestampUtc>
         </PwsDeleteDocumentVersionResult>
      </PwsDeleteDocumentVersionResponse>
   </s:Body>
</s:Envelope>
  • No labels