Overview
This web service returns can be used to check the locked state of an entity or set of entities. It can also, optionally, steal any existing locks on a the specified entity , and it can also steal a lock on an entity that is locked by another user.or entities. It can be used to determine whether your existing lock is still valid (has not expired and has not been stolen) – by specifying a Projector lock set id, or just to determine whether the specified entity or entities are already locked or not – by not specifying a Projector lock set id.
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Description | |||||
|---|---|---|---|---|---|---|---|---|
Int32 | No | Click here for more information | 1 | |||||
String | Yes | Click /wiki/spaces/QA/pages/11796515 for more information | AXMhtleRqwAazB/BUJaCKA== | |||||
Locks | PwsProjectorLockRequest[1..100] | Yes | This structure contains the complete set of information about a lock. | Int32 | No | the complete set of entities to check for existing locks. | ||
Int32 | No | If you hold an existing lock set over these entities and want to verify that the lock set is still valid, specify the lock set id here. Otherwise leave this null or omit it. Note if you do hold a lock set and do not specify the lock set id here, the service will report that the entities are currently locked. Click here for more information | ||||||
LocksToSteal | PwsEntityLockSummary[1..100] | NoThis structure includes basic information about a locked entity. The information represented in this structure is not comprehensive and only includes certain key attributes of a locked deemed to be useful in an acquisition of a lock. |
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:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsCheckProjectorLocks>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AXMhtleRqwAazB/BUJaCKA==</req:SessionTicket>
<req:Locks>
<com:PwsProjectorLockRequest>
<com:EntityIdentity>
<com:EntityCode>P001468-001</com:EntityCode>
<com:LockType>P</com:LockType>
</com:EntityIdentity>
</com:PwsProjectorLockRequest>
</req:Locks>
</pws:serviceRequest>
</pws:PwsCheckProjectorLocks>
</soapenv:Body>
</soapenv:Envelope> |
...