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

<ArrayOfLinkedDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <LinkedDocument>
    <DocumentDate>0001-01-01T00:00:00</DocumentDate>
    <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
    <DocumentMostRecentVersion>false</DocumentMostRecentVersion>
    <DocumentNumber>String</DocumentNumber>
    <DocumentTitle>String</DocumentTitle>
    <DocumentUserTitle>String</DocumentUserTitle>
    <DocumentVersion>String</DocumentVersion>
    <EntityTitle>String</EntityTitle>
    <FileType>String</FileType>
    <FileUrl>String</FileUrl>
    <ID>String</ID>
    <ShippingFormID>0</ShippingFormID>
  </LinkedDocument>
</ArrayOfLinkedDocument>