Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

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). You can specify how long the lock is good for (up to 1 day) when acquiring the lock. If you have acquired a lock and intend to hold onto that lock for a significant amount of time (perhaps longer than the requested period of time), you should periodically invoke this service at an appropriate frequency to prevent your lock from expiring.

Request Format


PwsRenewProjectorLocks Request
  • PwsRenewProjectorLocks
    • serviceRequest: PwsRenewProjectorLocksRq

Request Elements


Element

Data Type

Required?

Description

Sample Data

RequestId

Int32

No

Click here for more information.

1

SessionTicket

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

ProjectorLockSetId

Int32

Yes 

The lock set to be renewed. Click here for more information.

3839

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/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsRenewProjectorLocks>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AX6DNTSsd7jKIwQw0/RKxw==</req:SessionTicket>
            <req:LockDurationSeconds>300</req:LockDurationSeconds>
            <req:ProjectorLockSetId>3839</req:ProjectorLockSetId>
         </pws:serviceRequest>
      </pws:PwsRenewProjectorLocks>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsRenewProjectorLocks Response

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.

1

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-11-01T20:33:46.6885921Z

Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsRenewProjectorLocksResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsRenewProjectorLocksResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-11-01T20:33:46.6885921Z</ServerTimestampUtc>
         </PwsRenewProjectorLocksResult>
      </PwsRenewProjectorLocksResponse>
   </s:Body>
</s:Envelope>

PwsRenewProjectorLocks - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

50475SpecifiedLockNotFoundInvalid lock specified.
50485CannotRenewLockReleasedCannot renew lock because it has been released.
  • No labels