Overview

The web service locks a document defined by document identity (PwsDocumentRef). Locking a document is a way of signalling intention to update the document, and will prevent others from updating the document until the lock is released by updating the document or freeing the lock.

Request Format

PwsLockDocumentRq

PwsLockDocumentRq
- RequestId: Int32
- SessionTicket: String
- DocumentIdentity: PwsDocumentRef

Request Elements

Element	Data Type	Required?	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 locked. Click here for more information.

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:PwsLockDocument>
         <pws:serviceRequest>
            <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607634579</com:DocumentRefUid>
            </doc:DocumentIdentity>
         </pws:serviceRequest>
      </pws:PwsLockDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsLockDocumentRs

PwsLockDocumentRs
- 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-13T18:12:06.5571866Z

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsLockDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsLockDocumentResult 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-13T18:12:06.5571866Z</ServerTimestampUtc>
         </PwsLockDocumentResult>
      </PwsLockDocumentResponse>
   </s:Body>
</s:Envelope>

PwsLockDocument - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
75254	DocumentPendingArchiveCannotBeLocked	Document cannot be locked because it is pending archival.