/
PwsReleaseProjectorLocks

PwsReleaseProjectorLocks

Owned by Bettina Borces
Last updated: about 7 hours ago

Overview


This web service releases a lock that was acquired using PwsAcquireProjectorLocks. 


Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


PwsReleaseProjectorLocks Request
  • PwsReleaseProjectorLocks

Request Elements


Element

Data Type

Required?

Description

Sample Data

RequestId

Int32

No

Click here for more information.


SessionTicket

String

Yes 

Click here for more information.

AaoSuE89vJzjNFnsXZNioA==

ProjectorLockSetId

Int32

Yes 

The Projector lock set to be released. Click here for more information.

3673

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:PwsReleaseProjectorLocks>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AaoSuE89vJzjNFnsXZNioA==</req:SessionTicket>
            <req:ProjectorLockSetId>3673</req:ProjectorLockSetId>
         </pws:serviceRequest>
      </pws:PwsReleaseProjectorLocks>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsReleaseProjectorLocks 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.


StolenLock

PwsStolenLock

This structure will be populated if the user attempts to release a lock set that has been previously stolen. It includes basic information associated with the user who stole the lock (PwsUserSummary) as well as the ProjectorLockSetId.


Response Usage Example(s)


Example 01 - Releasing a lock 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsReleaseProjectorLocksResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsReleaseProjectorLocksResult 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-30T21:08:14.9814113Z</ServerTimestampUtc>
            <a:StolenLock i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsReleaseProjectorLocksResult>
      </PwsReleaseProjectorLocksResponse>
   </s:Body>
</s:Envelope>
Example 02 - Releasing a Stolen Lock 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsReleaseProjectorLocksResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsReleaseProjectorLocksResult 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/">
               <b:PwsMessage>
                  <b:AdditionalErrorText>Warning 50477: WARNING - Lock has been stolen. ### [referenceId1:3836]</b:AdditionalErrorText>
                  <b:ErrorCode i:nil="true"/>
                  <b:ErrorNumber>50477</b:ErrorNumber>
                  <b:ErrorText>Warning: Lock 3836 has been previously stolen.</b:ErrorText>
                  <b:Type>Warning</b:Type>
                  <b:ReferenceId1>3836</b:ReferenceId1>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
               <b:PwsMessage>
                  <b:AdditionalErrorText>Message 136: This request was executed against the QA Marlboro [secureqa.projectorpsa.com] environment.</b:AdditionalErrorText>
                  <b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
                  <b:ErrorNumber>136</b:ErrorNumber>
                  <b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
                  <b:Type>Information</b:Type>
                  <b:ReferenceId1 i:nil="true"/>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-11-01T19:29:20.4523566Z</ServerTimestampUtc>
            <a:StolenLock xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:LockStolenByUser>
                  <b:UserDisplayName>Web Services</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>WS01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607067736</b:UserUid>
                  <b:EmailAddress>webservices@revcorp.bb</b:EmailAddress>
                  <b:FirstName>Web</b:FirstName>
                  <b:LastName>Services</b:LastName>
                  <b:MiddleName i:nil="true"/>
               </b:LockStolenByUser>
               <b:ProjectorLockSetId>3836</b:ProjectorLockSetId>
            </a:StolenLock>
         </PwsReleaseProjectorLocksResult>
      </PwsReleaseProjectorLocksResponse>
   </s:Body>
</s:Envelope>


PwsReleaseProjectorLocks - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

50475SpecifiedLockNotFoundInvalid lock specified.
50476LockAlreadyReleasedWarning: Lock 3836 has already been released.