Overview
This web service restores a deleted document specified in the request. Documents that have been permanently deleted may not be undeleted.
Request Format
| Panel | ||
|---|---|---|
| ||
|
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 | Yes | The identity of the document that is to be undeleted. Click here for more information. | |||
| MakeNameUniqueFlag | Boolean | No | 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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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>ARaqO1NTOppS159NGsaYoA==</req:SessionTicket>
<doc:DocumentIdentity>
<com:DocumentRefUid>1152921504607775872</com:DocumentRefUid>
</doc:DocumentIdentity>
<doc:MakeNameUniqueFlag>true</doc:MakeNameUniqueFlag>
</pws:serviceRequest>
</pws:PwsUndeleteDocument>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 0 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-20T18:40:05.6295028Z |
| NewDocumentName | String | The new unique name of the undeleted document when request specifies MakeNameUniqueFlag as true. |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsUndeleteDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsUndeleteDocumentResult 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-20T18:40:05.6295028Z</ServerTimestampUtc> </PwsUndeleteDocumentResult> </PwsUndeleteDocumentResponse> </s:Body> </s:Envelope> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsUndeleteDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsUndeleteDocumentResult 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-12-18T18:58:29.8232667Z</ServerTimestampUtc> <a:NewDocumentName>Test (2).txt</a:NewDocumentName> </PwsUndeleteDocumentResult> </PwsUndeleteDocumentResponse> </s:Body> </s:Envelope> |
PwsUndeleteDocumentResponse - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 21012 | DocumentRequiredForUndeleteDocument | A document identity must be specified. |
| 75078 | DocumentNameAlreadyInUse | This folder already contains a document with the same name. Operation cannot be completed. |
| 75199 | DocumentNotFound | Document not found. |