| POST | /api/documents/movetorecyclebin |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* 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)
public static 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)
public UUID DocumentID = null;
/**
* Reason for moving the document to the recyclebin
*/
@ApiMember(Description="Reason for moving the document to the recyclebin")
public String Reason = null;
public UUID getDocumentID() { return DocumentID; }
public MoveDocumentToRecycleBin setDocumentID(UUID value) { this.DocumentID = value; return this; }
public String getReason() { return Reason; }
public MoveDocumentToRecycleBin setReason(String value) { this.Reason = value; return this; }
}
}
Java MoveDocumentToRecycleBin DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>