DigiOffice Gateway Web Services

GetNavigators

The following routes are available for this service:
GET	/api/views/{ViewId}/explorers/{ExplorerId}/navigators
GET	/api/documentviews/{ViewId}/explorers/{ExplorerId}/navigators

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class GetNavigators implements IConvertible
{
    String? ViewId;
    String? ExplorerId;
    String? Path;
    String? NodeExplorerID;
    String? SearchCriteria;

    GetNavigators({this.ViewId,this.ExplorerId,this.Path,this.NodeExplorerID,this.SearchCriteria});
    GetNavigators.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ViewId = json['ViewId'];
        ExplorerId = json['ExplorerId'];
        Path = json['Path'];
        NodeExplorerID = json['NodeExplorerID'];
        SearchCriteria = json['SearchCriteria'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ViewId': ViewId,
        'ExplorerId': ExplorerId,
        'Path': Path,
        'NodeExplorerID': NodeExplorerID,
        'SearchCriteria': SearchCriteria
    };

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

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

Dart GetNavigators 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/views/{ViewId}/explorers/{ExplorerId}/navigators HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv

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

[
	{
		EntityName: String,
		ID: String,
		ParentID: String,
		Title: String,
		Count: 0,
		ImageKey: String,
		Expanded: False,
		Selected: False,
		DisplayPath: String,
		ChildNodes: 
		[
			{
				EntityName: String,
				ID: String,
				ParentID: String,
				Title: String,
				Count: 0,
				ImageKey: String,
				Expanded: False,
				Selected: False,
				DisplayPath: String,
				ChildNodes: 
				[
					{
						EntityName: String,
						ID: String,
						ParentID: String,
						Title: String,
						Count: 0,
						ImageKey: String,
						Expanded: False,
						Selected: False,
						DisplayPath: String,
						RegistrationPathElement: String,
						QueryPathElement: String,
						Path: String,
						IsHierarchy: False
					}
				],
				RegistrationPathElement: String,
				QueryPathElement: String,
				Path: String,
				IsHierarchy: False
			}
		],
		RegistrationPathElement: String,
		QueryPathElement: String,
		Path: String,
		IsHierarchy: False
	}
]