Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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


Panel
titlePwsLockDocumentRq

...

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 locked. Click here for more information.


...

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

StatusRequestStatusClick here for more information.Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-13T18:12:06.5571866Z

...

Code Block
languagexml
titleExample 01
collapsetrue
<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

...