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

Overview

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

Request Format

PwsUnlockDocumentRq

Request Elements

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32



Click here for more information.


SessionTicket

String



Click here for more information.


DocumentIdentity

PwsDocumentRef





ForceUnlockFlag

Boolean





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

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

StatusRequestStatusClick here for more informationOk

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

ErrorNumberErrorCodeErrorText



  • No labels