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 |
|
| Click here for more information. |
|
SessionTicket | String |
|
| Click here for more information. |
|
DocumentIdentity |
|
|
|
| |
ForceUnlockFlag | Boolean |
|
|
|
|
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==</req:SessionTicket>
<doc:DocumentIdentity>
<com:DocumentRefUid>1152921504607652810</com:DocumentRefUid>
</doc:DocumentIdentity>
<doc:ForceUnlockFlag>true</doc:ForceUnlockFlag>
</pws:serviceRequest>
</pws:PwsUnlockDocument>
</soapenv:Body>
|
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages |
|
| |
ResponseId | Int32 | Click here for more information. |
|
Status | RequestStatus | Click here for more information. |
|
ServerTimestampUtc | DateTime | Click here for more information. |
|
Response Usage Example(s)
...
| ErrorNumber | ErrorCode | ErrorText | 75254 | DocumentPendingArchiveCannotBeLocked | Document cannot be locked because it is pending archival.|
|---|---|---|---|---|---|