DigiOffice Gateway Web 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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Navigation.Operations;

namespace IDB.API.DTO.Navigation.Operations
{
    public partial class GetNavigators
    {
        public virtual Guid ViewId { get; set; }
        public virtual Guid ExplorerId { get; set; }
        public virtual string Path { get; set; }
        public virtual string NodeExplorerID { get; set; }
        public virtual string SearchCriteria { get; set; }
    }

}

C# 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: doapigw.baasbv.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
	}
]