Versions Compared

Key

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

...

Panel
titlePwsUndeleteDocument Request

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.

AftyRXSTlnMPzozuKwq0kQ=

DocumentIdentity

PwsDocumentRef

Yes


The identity of the document that is to be undeleted. Click here for more information.


MakeNameUniqueFlagBooleanNo
If the undeleted document shares the same name as an existing document and this flag is set to 'true', then a number will appended to the undeleted document's name to make it unique.true

Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<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:PwsUndeleteDocument>
         <pws:serviceRequest>
            <req:SessionTicket>AftyRXSTlnMPzozuKwq0kQ==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607635451</com:DocumentRefUid>
            </doc:DocumentIdentity>
         </pws:serviceRequest>
      </pws:PwsUndeleteDocument>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsUndeleteDocument 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.

0

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-20T18:40:05.6295028Z
NewDocumentNameStringThe new unique name of the undeleted document when request specifies MakeNameUniqueFlag as true.

Response Usage Example(s)

...

ErrorNumber

ErrorCode

ErrorText

21012DocumentRequiredForUndeleteDocumentA document identity must be specified.
75078DocumentNameAlreadyInUseThis folder already contains a document with the same name. Operation cannot be completed.
75199DocumentNotFoundDocument not found.