| POST | /api/documents/movetorecyclebin |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Document.Operations
Namespace Global
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 Overridable Property DocumentID As Guid
'''<Summary>
'''Reason for moving the document to the recyclebin
'''</Summary>
<ApiMember(Description:="Reason for moving the document to the recyclebin")>
Public Overridable Property Reason As String
End Class
End Namespace
End Namespace
VB.NET MoveDocumentToRecycleBin DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"DocumentID":"00000000-0000-0000-0000-000000000000","Reason":"String"}