DigiOffice API Services Services

GetDocumentStorageSystemStatus

Check storagesystem status for a document and update if necessary.

The following routes are available for this service:
GET	/api/documents/{DocumentID}/checkstoragesystem

"use strict";
/** @typedef {'Error'|'Waiting'|'NoAction'|'Busy'} */
export var CheckStorageSystemStatus;
(function (CheckStorageSystemStatus) {
    CheckStorageSystemStatus["Error"] = "Error"
    CheckStorageSystemStatus["Waiting"] = "Waiting"
    CheckStorageSystemStatus["NoAction"] = "NoAction"
    CheckStorageSystemStatus["Busy"] = "Busy"
})(CheckStorageSystemStatus || (CheckStorageSystemStatus = {}));
export class GetDocumentStorageSystemStatusResponse {
    /** @param {{CheckStorageSystemStatus?:CheckStorageSystemStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CheckStorageSystemStatus} */
    CheckStorageSystemStatus;
}
export class GetDocumentStorageSystemStatus {
    /** @param {{DocumentID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description DocumentID to be checked */
    DocumentID;
}

JavaScript GetDocumentStorageSystemStatus DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/documents/{DocumentID}/checkstoragesystem HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CheckStorageSystemStatus: Error
}