Overview
This web service removes older version of a Projector document. If the version number is provided, the versions that are older than the specified version are purged. Otherwise, any version older than the current version, if exists, is purged.
Request Format
| Panel | ||
|---|---|---|
| ||
|
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. | AftyRXSTlnMPzozuKwq0kQ== | |
DocumentIdentity | Yes | The document whose versions are to be purged. Click here for more information. | |||
VersionNumber | Int16 | No | The current version number | Document versions lower than the version number specified is purged. If not specified, the current version number is used as default. | 2 |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 0 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-20T12:55:43.7326435Z |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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. |