Overview

The web service unlocks a document defined by document identity (PwsDocumentRef).

Request Format

PwsUnlockDocumentRq

PwsUnlockDocumentRq
- RequestId: Int32
- SessionTicket: String
- DocumentIdentity: PwsDocumentRef
- ForceUnlockFlag: Boolean

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.
SessionTicket	String	Yes		Click here for more information.	ATtU220EvBSE2+GCN9U58g==
DocumentIdentity	PwsDocumentRef	Yes		The document that is to be unlocked. Click here for more information.
ForceUnlockFlag	Boolean	No	false		false

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/" xmlns:doc="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsUnlockDocument>
         <pws:serviceRequest>
            <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607652810</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:ForceUnlockFlag>true</doc:ForceUnlockFlag>
         </pws:serviceRequest>
      </pws:PwsUnlockDocument>
   </soapenv:Body>

Response Format

PwsUnlockDocumentRs

PwsUnlockDocumentRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime

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.	0
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-03-13T19:02:38.9877763Z

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsUnlockDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsUnlockDocumentResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-13T19:02:38.9877763Z</ServerTimestampUtc>
         </PwsUnlockDocumentResult>
      </PwsUnlockDocumentResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText