DigiOffice Gateway Web Services

<back to all web services

GetDocumentViews

Requires Authentication
The following routes are available for this service:
GET/api/documentviews
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class GetDocumentViews implements IConvertible
{
    bool? IncludeExplorers;
    String? WorkspaceID;

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

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

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

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

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

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

[
	{
		TranslateKey: String,
		SiteMapKey: String,
		Title: String,
		ImageUrl: String,
		ChildrenCount: 0,
		Order: 0,
		Explorers: 
		[
			{
				Title: String,
				Order: 0
			}
		]
	}
]