POST | /api/documents/movetorecyclebin |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
namespace IDB.API.DTO.Document.Operations
{
///<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)]
public partial class 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)]
public virtual Guid DocumentID { get; set; }
///<summary>
///Reason for moving the document to the recyclebin
///</summary>
[ApiMember(Description="Reason for moving the document to the recyclebin")]
public virtual string Reason { get; set; }
}
}
C# 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
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"}