Overview

The web service unlocks a document defined by document identity (PwsDocumentRef).

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

PwsUnlockDocumentRq

PwsUnlockDocumentRq
- RequestId: Int32
- SessionTicket: String
- DocumentIdentity: PwsDocumentRef
- ForceUnlockFlag: 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.	ATtU220EvBSE2+GCN9U58g==
DocumentIdentity	PwsDocumentRef	Yes		The document that is to be unlocked. Click here for more information.
ForceUnlockFlag	Boolean	No	false	If set to 'true', this will unlock the document no matter who has the document locked. If set to 'false', this request will fail if this document is locked by someone other than the requesting user.	false

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:PwsUnlockDocument>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Adsu6XbrXVEKIXarSoTWSw==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504608098089</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:ForceUnlockFlag>true</doc:ForceUnlockFlag>
         </pws:serviceRequest>
      </pws:PwsUnlockDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsUnlockDocumentRs

PwsUnlockDocumentRs
- 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-03-13T19:02:38.9877763Z

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsUnlockDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsUnlockDocumentResult 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2021-06-01T16:03:07.5609174Z</ServerTimestampUtc>
         </PwsUnlockDocumentResult>
      </PwsUnlockDocumentResponse>
   </s:Body>
</s:Envelope>

PwsUnlockDocument - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
75180	DocumentIsLocked	Document is locked.
75199	DocumentNotFound	Document not found.

API Documentation

PwsUnlockDocument

Analytics

Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsUnlockDocument - Common Errors and Warnings

Related content

PwsUnlockDocument

[data-colorid=x5tos70gwb]{color:#292a2e} html[data-color-mode=dark] [data-colorid=x5tos70gwb]{color:#d1d2d6}[data-colorid=twf5rgw62k]{color:#292a2e} html[data-color-mode=dark] [data-colorid=twf5rgw62k]{color:#d1d2d6}Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsUnlockDocument - Common Errors and Warnings

Related content

Overview