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 6 Next »

Overview


This web service acquires a lock for a specified entity.

Request Format

Request Elements

Request Usage Example(s)


Example 01 - Acquiring an Available Lock
<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>
Example 02 - Stealing a Lock
<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>
            <req:LocksToSteal>
               <com:PwsEntityLockSummary>
                  <com:EntityIdentity>
                     <com:EntityCode>P001468-001</com:EntityCode>
                     <com:EntityUid>1152921504607429941</com:EntityUid>
                     <com:LockType>P</com:LockType>
                  </com:EntityIdentity>
                  <com:EntityLockSummary>
                     <com:PwsEntityLockSummaryItem>
                        <com:LockCount>1</com:LockCount>
                        <com:LockHolderUserIdentity>
                           <com:UserDisplayName>IT Manager</com:UserDisplayName>
                           <com:UserReferenceSystemId>IT Manager</com:UserReferenceSystemId>
                        </com:LockHolderUserIdentity>
                        <com:MostRecentLockAcquisitionTimestamp>2018-10-16T13:59:12.903Z</com:MostRecentLockAcquisitionTimestamp>
                     </com:PwsEntityLockSummaryItem>
                  </com:EntityLockSummary>
               </com:PwsEntityLockSummary>
            </req:LocksToSteal>
         </pws:serviceRequest>
      </pws:PwsAcquireProjectorLocks>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

Response Elements

Response Usage Example(s)

Example 01 - Acquiring an Available Lock
<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>
Example 02 - Stealing a Lock
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:Client</faultcode>
         <faultstring xml:lang="en-US">The creator of this fault did not specify a Reason.</faultstring>
         <detail>
            <PwsFault xmlns="http://projectorpsa.com/DataContracts/Shared/Common/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
               <Messages>
                  <PwsMessage>
                     <AdditionalErrorText>Error 50469: EntityAlreadyLocked</AdditionalErrorText>
                     <ErrorCode>EntityAlreadyLocked</ErrorCode>
                     <ErrorNumber>50469</ErrorNumber>
                     <ErrorText>One or more existing locks prevent acquisition of requested lock.</ErrorText>
                     <Type>Error</Type>
                     <ReferenceId1 i:nil="true"/>
                     <ReferenceId2 i:nil="true"/>
                  </PwsMessage>
               </Messages>
               <ResponseId>1</ResponseId>
               <ServiceName>PwsAcquireProjectorLocksRs</ServiceName>
               <LockHolderUserIdentity>
                  <UserDisplayName>IT Manager</UserDisplayName>
                  <UserId i:nil="true"/>
                  <UserReferenceSystemId>IT Manager</UserReferenceSystemId>
                  <UserUid>1152921504607134339</UserUid>
               </LockHolderUserIdentity>
               <LockHolders>
                  <PwsEntityLockSummary>
                     <EntityIdentity>
                        <EntityCode>P001468-001</EntityCode>
                        <EntityId i:nil="true"/>
                        <EntityUid>1152921504607429941</EntityUid>
                        <LockType>P</LockType>
                     </EntityIdentity>
                     <EntityLockSummary>
                        <PwsEntityLockSummaryItem>
                           <LockCount>1</LockCount>
                           <LockHolderUserIdentity>
                              <UserDisplayName>IT Manager</UserDisplayName>
                              <UserId i:nil="true"/>
                              <UserReferenceSystemId>IT Manager</UserReferenceSystemId>
                              <UserUid>1152921504607134339</UserUid>
                           </LockHolderUserIdentity>
                           <MostRecentLockAcquisitionTimestamp>2018-10-16T17:34:43.037Z</MostRecentLockAcquisitionTimestamp>
                        </PwsEntityLockSummaryItem>
                     </EntityLockSummary>
                  </PwsEntityLockSummary>
               </LockHolders>
               <LockTaker i:nil="true"/>
            </PwsFault>
         </detail>
      </s:Fault>
   </s:Body>
</s:Envelope>


PwsAcquireProjectorLocks - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

10126InvalidEnumerationValueSpecifiedAn invalid value was specified for LockType. Valid values are E, C, P, R, RT, CP, CB, I.
50469EntityAlreadyLockedOne or more existing locks prevent acquisition of requested lock.
50483InvalidLockDurationLock duration must between one second and one day.
  • No labels