DigiOffice API Services Services

<back to all web services

GetNavigators

Requires Authentication
The following routes are available for this service:
GET/api/views/{ViewId}/explorers/{ExplorerId}/navigators
GET/api/documentviews/{ViewId}/explorers/{ExplorerId}/navigators
"use strict";
export class GetNavigators {
    /** @param {{ViewId?:string,ExplorerId?:string,Path?:string,NodeExplorerID?:string,SearchCriteria?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ViewId;
    /** @type {string} */
    ExplorerId;
    /** @type {string} */
    Path;
    /** @type {string} */
    NodeExplorerID;
    /** @type {string} */
    SearchCriteria;
}

JavaScript 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: test-do-services.klokgroep.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
	}
]