DigiOffice Gateway Web Services

GetDocumentViewDetails

The following routes are available for this service:
GET POST	/api/documentviews/{Key}

import 'package:servicestack/servicestack.dart';

class Explorer implements IConvertible
{
    String? ID;
    String? Title;
    int? Order;

    Explorer({this.ID,this.Title,this.Order});
    Explorer.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'Title': Title,
        'Order': Order
    };

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

// @DataContract
abstract class MobileView
{
    // @DataMember
    String? ID;

    // @DataMember
    String? Title;

    // @DataMember
    String? ImageUrl;

    // @DataMember
    int? ChildrenCount;

    // @DataMember
    int? Order;

    // @DataMember
    List<Explorer>? Explorers;

    MobileView({this.ID,this.Title,this.ImageUrl,this.ChildrenCount,this.Order,this.Explorers});
    MobileView.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        Title = json['Title'];
        ImageUrl = json['ImageUrl'];
        ChildrenCount = json['ChildrenCount'];
        Order = json['Order'];
        Explorers = JsonConverters.fromJson(json['Explorers'],'List<Explorer>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'Title': Title,
        'ImageUrl': ImageUrl,
        'ChildrenCount': ChildrenCount,
        'Order': Order,
        'Explorers': JsonConverters.toJson(Explorers,'List<Explorer>',context!)
    };

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

class DocumentView extends MobileView implements IConvertible
{
    // @DataMember
    String? TranslateKey;

    // @DataMember
    String? SiteMapKey;

    DocumentView({this.TranslateKey,this.SiteMapKey});
    DocumentView.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        TranslateKey = json['TranslateKey'];
        SiteMapKey = json['SiteMapKey'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'TranslateKey': TranslateKey,
        'SiteMapKey': SiteMapKey
    });

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

class GetDocumentViewDetails implements IConvertible
{
    String? Key;
    bool? IncludeExplorers;

    GetDocumentViewDetails({this.Key,this.IncludeExplorers});
    GetDocumentViewDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'Explorer': TypeInfo(TypeOf.Class, create:() => Explorer()),
    'MobileView': TypeInfo(TypeOf.AbstractClass),
    'List<Explorer>': TypeInfo(TypeOf.Class, create:() => <Explorer>[]),
    'DocumentView': TypeInfo(TypeOf.Class, create:() => DocumentView()),
    'GetDocumentViewDetails': TypeInfo(TypeOf.Class, create:() => GetDocumentViewDetails()),
});

Dart GetDocumentViewDetails 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.

POST /api/documentviews/{Key} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentViewDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <IncludeExplorers>false</IncludeExplorers>
  <Key>String</Key>
</GetDocumentViewDetails>

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

<DocumentView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <ChildrenCount xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</ChildrenCount>
  <Explorers xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Navigation" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">
    <d2p1:Explorer>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:Explorer>
  </Explorers>
  <ID xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">00000000-0000-0000-0000-000000000000</ID>
  <ImageUrl xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">String</ImageUrl>
  <Order xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</Order>
  <Title xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">String</Title>
  <SiteMapKey>String</SiteMapKey>
  <TranslateKey>String</TranslateKey>
</DocumentView>