DigiOffice API Services Services

<back to all web services

AddFile

Requires Authentication
"use strict";
export class AddFileResponse {
    /** @param {{FileID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FileID;
}
export class AddFile {
    /** @param {{Link?:string,BlobID?:string,Size?:number,IsAttachment?:boolean,Data?:boolean,OCR?:boolean,Preview?:boolean,Type?:string,DateTimeLastModified?:string,MetricHeight?:number,MetricWidth?:number,DocumentID?:string,OriginalFileName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Link;
    /** @type {?string} */
    BlobID;
    /** @type {?number} */
    Size;
    /** @type {boolean} */
    IsAttachment;
    /** @type {boolean} */
    Data;
    /** @type {boolean} */
    OCR;
    /** @type {boolean} */
    Preview;
    /** @type {string} */
    Type;
    /** @type {?string} */
    DateTimeLastModified;
    /** @type {?number} */
    MetricHeight;
    /** @type {?number} */
    MetricWidth;
    /** @type {?string} */
    DocumentID;
    /** @type {string} */
    OriginalFileName;
}

JavaScript AddFile DTOs

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

HTTP + OTHER

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

POST /jsonl/reply/AddFile HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Link":"String","BlobID":"00000000-0000-0000-0000-000000000000","Size":0,"IsAttachment":false,"Data":false,"OCR":false,"Preview":false,"Type":"String","DateTimeLastModified":"0001-01-01T00:00:00.0000000","MetricHeight":0,"MetricWidth":0,"DocumentID":"00000000-0000-0000-0000-000000000000","OriginalFileName":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"FileID":"00000000-0000-0000-0000-000000000000"}