/
PwsRollbackDocument

PwsRollbackDocument

Overview


This web service rolls back the version of a document from the current one to an earlier version. The specific version to roll back to may be provided in the request. If not provided the document is rolled back to the version just prior to the current one. 


Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


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

AftyRXSTlnMPzozuKwq0kQ==

DocumentIdentity

PwsDocumentRef

Yes


The document whose version is to be rolled back. Click here for more information.


VersionNumber

Int16

No

current version number - 1

The earlier version a document is rolled back to. If not specified, the version number is current version number - 1.

3

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

Response Format


PwsRollbackDocument 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-03-20T15:17:56.0309379Z

Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsRollbackDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsRollbackDocumentResult 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-20T15:17:56.0309379Z</ServerTimestampUtc>
         </PwsRollbackDocumentResult>
      </PwsRollbackDocumentResponse>
   </s:Body>
</s:Envelope>

PwsRollbackDocument - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

21008DocumentRequiredForRollbackDocumentA document identity must be specified.
75199DocumentNotFoundDocument not found.
75207VersionNumberDoesNotExistSpecified version number does not exist.