DigiOffice Gateway Web Services

<back to all web services

GetLinkedDocuments

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

class GetLinkedDocuments implements IConvertible
{
    String? DocumentID;

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

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

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

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

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

Dart GetLinkedDocuments 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}/linkeddocuments HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		ID: String,
		EntityTitle: String,
		DocumentNumber: String,
		DocumentVersion: String,
		DocumentMostRecentVersion: False,
		ShippingFormID: 0,
		DocumentTitle: String,
		DocumentDate: 0001-01-01,
		DocumentUserTitle: String,
		FileUrl: String,
		FileType: String
	}
]