Overview
The web service locks unlocks a document defined by document identity (PwsDocumentRef).
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. | ATtU220EvBSE2+GCN9U58g== | |
DocumentIdentity | 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)
| 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:PwsUnlockDocument>
<pws:serviceRequest>
<req:SessionTicket>ATtU220EvBSE2+GCN9U58g:RequestId>1</req:RequestId>
<req:SessionTicket>Adsu6XbrXVEKIXarSoTWSw==</req:SessionTicket>
<doc:DocumentIdentity>
<com:DocumentRefUid>1152921504607652810<DocumentRefUid>1152921504608098089</com:DocumentRefUid>
</doc:DocumentIdentity>
<doc:ForceUnlockFlag>true</doc:ForceUnlockFlag>
</pws:serviceRequest>
</pws:PwsUnlockDocument>
</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 | RequestStatus | Click here for more information. | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-13T19:02:38.9877763Z |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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/">0<>1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018>2021-0306-13T1901T16:0203:3807.9877763Z<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 |
|---|---|---|
| 7525475180 | DocumentPendingArchiveCannotBeLockedDocumentIsLocked | Document cannot be locked because it is pending archivalis locked. |
| 75199 | DocumentNotFound | Document not found. |