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
namespace IDB.API.DTO.Navigation.Operations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GetNavigators() = 
        member val ViewId:Guid = new Guid() with get,set
        member val ExplorerId:Guid = new Guid() with get,set
        member val Path:String = null with get,set
        member val NodeExplorerID:String = null with get,set
        member val SearchCriteria:String = null with get,set

F# GetNavigators DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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","ChildNodes":null,"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}]