Overview

This web service removes older version of a Projector document. If there is only one version exists, the web service is a no-op.

Request Format

PwsPurgeDocument Request

PwsPurgeDocument
- serviceRequest: PwsPurgeDocumentRq
  - RequestId: Int32
  - SessionTicket: String
  - DocumentIdentity: PwsDocumentRef
  - VersionNumber: Int16

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.
SessionTicket	String	Yes	Click here for more information.
DocumentIdentity	PwsDocumentRef
VersionNumber	Int16			2

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:PwsPurgeDocument>
         <pws:serviceRequest>
            <req:SessionTicket>AftyRXSTlnMPzozuKwq0kQ==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607634579</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:VersionNumber>2</doc:VersionNumber>
         </pws:serviceRequest>
      </pws:PwsPurgeDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsPurgeDocument Response

PwsPurgeDocumentResponse
- PwsPurgeDocumentResult: PwsPurgeDocumentRs
  - 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 informaiton.
ResponseId	Int32	Click here for more information.	0
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-03-20T12:55:43.7326435Z

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsPurgeDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsPurgeDocumentResult 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-03-20T12:55:43.7326435Z</ServerTimestampUtc>
         </PwsPurgeDocumentResult>
      </PwsPurgeDocumentResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
21007	DocumentRequiredForPurgeDocument	A document identity must be specified.
75199	DocumentNotFound	Document not found.