Versions Compared

Key

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

...

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


Response Usage Example(s)


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>

...

Code Block
languagexml
titleExample 02 - Stealing a 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-17T15:28:07.9156991Z</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>AAAAABCnqY8=</b:EntityTimestamp>
                  <b:LockStolenFlag>true</b:LockStolenFlag>
                  <b:StolenLocks>
                     <b:PwsEntityLockSummaryItem>
                        <b:LockCount>1</b:LockCount>
                        <b:LockHolderUserIdentity>
                           <b:UserDisplayName>IT Manager</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>IT Manager</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607134339</b:UserUid>
                        </b:LockHolderUserIdentity>
                        <b:MostRecentLockAcquisitionTimestamp>2018-10-17T15:24:42.897Z</b:MostRecentLockAcquisitionTimestamp>
                     </b:PwsEntityLockSummaryItem>
                  </b:StolenLocks>
               </b:PwsProjectorLock>
            </a:Locks>
            <a:ProjectorLockSetId>2621</a:ProjectorLockSetId>
         </PwsAcquireProjectorLocksResult>
      </PwsAcquireProjectorLocksResponse>
   </s:Body>
</s:Envelope>

...