DigiOffice API Services Services

<back to all web services

GetDocumentFileDetails

Requires Authentication
The following routes are available for this service:
GET/api/documents/{DocumentID}/filedetails
"use strict";
export class DocumentFile {
    /** @param {{Name?:string,Extension?:string,Size?:number,Content?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Extension;
    /** @type {number} */
    Size;
    /** @type {string} */
    Content;
}
export class GetDocumentFileDetails {
    /** @param {{DocumentID?:string,IncludeContent?:boolean,DocumentFieldID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentID;
    /** @type {boolean} */
    IncludeContent;
    /** @type {string} */
    DocumentFieldID;
}

JavaScript GetDocumentFileDetails 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.

GET /api/documents/{DocumentID}/filedetails HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <Content>AA==</Content>
  <Extension>String</Extension>
  <Name>String</Name>
  <Size>0</Size>
</DocumentFile>