Overview
This web service renews an active lock that was acquired using PwsAcquireProjectorLocks. Locks are valid for a set amount of time (as a means of avoiding stale locks and the related problems). If you have acquired a lock and intend to hold onto that lock for a significant amount of time, you should periodically invoke this service to prevent your lock from expiring.
Request Format
- PwsRenewProjectorLocks
- serviceRequest: PwsRenewProjectorLocksRq
- RequestId: Int32
- SessionTicket: String
- LockDurationSeconds: Int32
- ProjectorLockSetId: Int32
- serviceRequest: PwsRenewProjectorLocksRq
Request Elements
Element | Data Type | Required? | Description | Sample Data |
---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | |
String | Yes | Click here for more information. | AX6DNTSsd7jKIwQw0/RKxw== | |
LockDurationSeconds | Int32 | Yes | The number of seconds the lock will be held. Must be between 1 second and 1 day (86400 seconds). | 300 |
Int32 | Yes | The lock set to be renewed. Click here for more information. | 3839 |
Request Usage Example(s)
Response Format
- PwsRenewProjectorLocksResponse
- PwsRenewProjectorLocksResult: PwsRenewProjectorLocksRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- PwsRenewProjectorLocksResult: PwsRenewProjectorLocksRs
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information. | 1 | |
Status | Click here for more information. | Ok | |
DateTime | Click here for more information. | 2018-11-01T20:33:46.6885921Z |
Response Usage Example(s)
PwsRenewProjectorLocks - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
50475 | SpecifiedLockNotFound | Invalid lock specified. |
50485 | CannotRenewLockReleased | Cannot renew lock because it has been released. |