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
"use strict";
export class MoveDocumentToRecycleBin {
    /** @param {{DocumentID?:string,Reason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID of the document that must be moved to the recycle bin */
    DocumentID;
    /**
     * @type {string}
     * @description Reason for moving the document to the recyclebin */
    Reason;
}

JavaScript MoveDocumentToRecycleBin DTOs

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

HTTP + 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: dogw.klokgroep.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>