| POST | /api/documents/movetorecyclebin |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
# @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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MoveDocumentToRecycleBin:
"""
Move document to the Recycle Bin
"""
# @ApiMember(Description="ID of the document that must be moved to the recycle bin", IsRequired=true)
document_i_d: Optional[str] = None
"""
ID of the document that must be moved to the recycle bin
"""
# @ApiMember(Description="Reason for moving the document to the recyclebin")
reason: Optional[str] = None
"""
Reason for moving the document to the recyclebin
"""
Python MoveDocumentToRecycleBin DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
Reason: String
}