DigiOffice API Services Services

<back to all web services

GetDocumentAttachments

Requires Authentication
The following routes are available for this service:
GET/api/documents/{DocumentID}/attachments
"use strict";
export class GetDocumentAttachments {
    /** @param {{DocumentID?:string,IncludeSelf?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentID;
    /** @type {boolean} */
    IncludeSelf;
}

JavaScript GetDocumentAttachments 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}/attachments HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDocumentAttachment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <DocumentAttachment>
    <DetailUrl>String</DetailUrl>
    <DownloadName>String</DownloadName>
    <ID>00000000-0000-0000-0000-000000000000</ID>
    <IsMainDocument>false</IsMainDocument>
    <IsPrefferedDocument>false</IsPrefferedDocument>
    <Link>String</Link>
    <LinkTypeDescription>String</LinkTypeDescription>
    <Title>String</Title>
  </DocumentAttachment>
</ArrayOfDocumentAttachment>