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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class GetNavigators
    {
        public UUID ViewId = null;
        public UUID ExplorerId = null;
        public String Path = null;
        public String NodeExplorerID = null;
        public String SearchCriteria = null;
        
        public UUID getViewId() { return ViewId; }
        public GetNavigators setViewId(UUID value) { this.ViewId = value; return this; }
        public UUID getExplorerId() { return ExplorerId; }
        public GetNavigators setExplorerId(UUID value) { this.ExplorerId = value; return this; }
        public String getPath() { return Path; }
        public GetNavigators setPath(String value) { this.Path = value; return this; }
        public String getNodeExplorerID() { return NodeExplorerID; }
        public GetNavigators setNodeExplorerID(String value) { this.NodeExplorerID = value; return this; }
        public String getSearchCriteria() { return SearchCriteria; }
        public GetNavigators setSearchCriteria(String value) { this.SearchCriteria = value; return this; }
    }

}

Java GetNavigators DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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}]