Versions Compared

Key

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

...

Panel
titlePwsAcquireProjectorLocks Request

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No

 


Click here for more information

1

SessionTicket

String (50)

Yes

 


Click here for more information

AYlq2lioh82F1PapkJ+Npg==

LockDurationSeconds

Int32

Yes 

 


The number of seconds the lock will be held must be between 1 second and 1 day (86400)

120

Locks

PwsProjectorLockRequest[]

Yes

 


The detailed information of the lock that is to be acquired


LocksToSteal

PwsEntityLockSummary[]

No

 


The detailed information of the lock that is to be stolen


ProjectorLockSetId

Int32

No

 


A unique identifier of a lock on an entity 


Request Usage Example(s)


Code Block
languagexml
titleExample 01 - Acquiring an Available Lock
collapsetrue
<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:PwsAcquireProjectorLocks>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AYlq2lioh82F1PapkJ+Npg==</req:SessionTicket>
            <req:LockDurationSeconds>120</req:LockDurationSeconds>
            <req:Locks>
               <com:PwsProjectorLockRequest>
                  <com:EntityIdentity>
                     <com:EntityCode>P001468-001</com:EntityCode>
                     <com:EntityUid>1152921504607429941</com:EntityUid>
                     <com:LockType>P</com:LockType>
                  </com:EntityIdentity>
               </com:PwsProjectorLockRequest>
            </req:Locks>
         </pws:serviceRequest>
      </pws:PwsAcquireProjectorLocks>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsAcquireProjectorLocks Response


Response Elements


Element

Data Type

DescriptionSample 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-10-16T17:28:12.1700152Z

Locks

PwsProjectorLock[]

The complete set of information about the lock

ProjectorLockSetId

Int32

A unique identifier of a lock on an entity 
2602



Code Block
languagexml
titleExample 01 - Acquiring an Available Lock
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAcquireProjectorLocksResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAcquireProjectorLocksResult 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-10-16T17:28:12.1700152Z</ServerTimestampUtc>
            <a:Locks xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsProjectorLock>
                  <b:EntityIdentity>
                     <b:EntityCode>P001468-001</b:EntityCode>
                     <b:EntityId i:nil="true"/>
                     <b:EntityUid>1152921504607429941</b:EntityUid>
                     <b:LockType>P</b:LockType>
                  </b:EntityIdentity>
                  <b:EntityTimestamp>AAAAABCnqW4=</b:EntityTimestamp>
                  <b:LockStolenFlag>false</b:LockStolenFlag>
                  <b:StolenLocks/>
               </b:PwsProjectorLock>
            </a:Locks>
            <a:ProjectorLockSetId>2602</a:ProjectorLockSetId>
         </PwsAcquireProjectorLocksResult>
      </PwsAcquireProjectorLocksResponse>
   </s:Body>
</s:Envelope>

...