Overview

This web service deletes a version (PwsDocumentVersionRef) of a specified document (PwsDocumentRef). Multiple versions of a single document can be stored for project workspace documents, invoice documents, resource resumes and project issue attachments. If you delete the current version of a document, the prior version will become the current version. If a document contains a single version, you will not be able to delete the version. Use PwsDeleteDocument to delete the document instead.

Request Format

PwsDeleteDocumentVersion Request

PwsDeleteDocumentVersion
- serviceRequest: PwsDeleteDocumentVersionRq
  - RequestId: Int32
  - SessionTicket: String
  - DocumentIdentity: PwsDocumentRef
  - DocumentVersionIdentity: PwsDocumentVersionRef
  - OverrideLockFlag: Boolean

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.	AW1UpKK1eVCbgfEayQrXEA==
DocumentIdentity	PwsDocumentRef	Yes		This is the identity of the document containing the version 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', an existing lock on the document will not prevent the version from being deleted.	true

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

PwsDeleteDocumentVersionResponse
- PwsDeleteDocumentVersionResult: PwsDeleteDocumentVersionRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime

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>

PwsDeleteDocumentVersion - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
21011	DocumentRequiredForDeleteDocument	A document identity must be specified.
21034	DocumentVersionRequiredForDeleteDocumentVersion	A document version identity must be specified.
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.
75199	DocumentNotFound	Document version cannot be deleted because the document is locked
75202	DocumentVersionNotFound	Document version not found.
75233	CannotDeleteVersionDocumentLocked	Document version cannot be deleted because the document is locked.