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
namespace IDB.API.DTO.Document.Operations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Move document to the Recycle Bin
    ///</summary>
    [<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)>]
    [<AllowNullLiteral>]
    type MoveDocumentToRecycleBin() = 
        ///<summary>
        ///ID of the document that must be moved to the recycle bin
        ///</summary>
        [<ApiMember(Description="ID of the document that must be moved to the recycle bin", IsRequired=true)>]
        member val DocumentID:Guid = new Guid() with get,set

        ///<summary>
        ///Reason for moving the document to the recyclebin
        ///</summary>
        [<ApiMember(Description="Reason for moving the document to the recyclebin")>]
        member val Reason:String = null with get,set

F# MoveDocumentToRecycleBin DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","Reason":"String"}