DigiOffice Gateway Web Services

<back to all web services

GetDocumentAttachments

Requires Authentication
The following routes are available for this service:
GET/api/documents/{DocumentID}/attachments
import 'package:servicestack/servicestack.dart';

class GetDocumentAttachments implements IConvertible
{
    String? DocumentID;
    bool? IncludeSelf;

    GetDocumentAttachments({this.DocumentID,this.IncludeSelf});
    GetDocumentAttachments.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentID = json['DocumentID'];
        IncludeSelf = json['IncludeSelf'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentID': DocumentID,
        'IncludeSelf': IncludeSelf
    };

    getTypeName() => "GetDocumentAttachments";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'GetDocumentAttachments': TypeInfo(TypeOf.Class, create:() => GetDocumentAttachments()),
});

Dart GetDocumentAttachments DTOs

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

HTTP + CSV

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: digiofficeapigateway.deltares.nl 
Accept: text/csv

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

[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","DownloadName":"String","LinkTypeDescription":"String","IsPrefferedDocument":false,"IsMainDocument":false,"Link":"String","DetailUrl":"String"}]