DigiOffice Gateway Web Services

<back to all web services

MoveDocumentToRecycleBin

Move document to the Recycle Bin

Requires Authentication
The following routes are available for this service:
POST/api/documents/movetorecyclebin
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Move document to the Recycle Bin
*/
@Api(Description="Move document to the Recycle Bin")
@ApiResponse(Description="Document is moved to recycle bin", StatusCode=204)
// @ApiResponse(Description="Unauthorized to read document", StatusCode=401)
// @ApiResponse(Description="Document not found", StatusCode=410)
// @ApiResponse(Description="Document is already in recycle bin, document is not newest version, user has no 'move to recycle bin' access or document is locked/checked out by a user", StatusCode=405)
open class MoveDocumentToRecycleBin
{
    /**
    * ID of the document that must be moved to the recycle bin
    */
    @ApiMember(Description="ID of the document that must be moved to the recycle bin", IsRequired=true)
    var DocumentID:UUID? = null

    /**
    * Reason for moving the document to the recyclebin
    */
    @ApiMember(Description="Reason for moving the document to the recyclebin")
    var Reason:String? = null
}

Kotlin MoveDocumentToRecycleBin DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/documents/movetorecyclebin HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MoveDocumentToRecycleBin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <Reason>String</Reason>
</MoveDocumentToRecycleBin>