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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetNavigators:
    view_id: Optional[str] = None
    explorer_id: Optional[str] = None
    path: Optional[str] = None
    node_explorer_i_d: Optional[str] = None
    search_criteria: Optional[str] = None

Python GetNavigators DTOs

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfNode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Navigation">
  <Node>
    <ChildNodes>
      <Node>
        <ChildNodes>
          <Node>
            <ChildNodes i:nil="true" />
            <Count>0</Count>
            <DisplayPath>String</DisplayPath>
            <EntityName>String</EntityName>
            <Expanded>false</Expanded>
            <ID>String</ID>
            <ImageKey>String</ImageKey>
            <IsHierarchy>false</IsHierarchy>
            <ParentID>String</ParentID>
            <Path>String</Path>
            <QueryPathElement>String</QueryPathElement>
            <RegistrationPathElement>String</RegistrationPathElement>
            <Selected>false</Selected>
            <Title>String</Title>
          </Node>
        </ChildNodes>
        <Count>0</Count>
        <DisplayPath>String</DisplayPath>
        <EntityName>String</EntityName>
        <Expanded>false</Expanded>
        <ID>String</ID>
        <ImageKey>String</ImageKey>
        <IsHierarchy>false</IsHierarchy>
        <ParentID>String</ParentID>
        <Path>String</Path>
        <QueryPathElement>String</QueryPathElement>
        <RegistrationPathElement>String</RegistrationPathElement>
        <Selected>false</Selected>
        <Title>String</Title>
      </Node>
    </ChildNodes>
    <Count>0</Count>
    <DisplayPath>String</DisplayPath>
    <EntityName>String</EntityName>
    <Expanded>false</Expanded>
    <ID>String</ID>
    <ImageKey>String</ImageKey>
    <IsHierarchy>false</IsHierarchy>
    <ParentID>String</ParentID>
    <Path>String</Path>
    <QueryPathElement>String</QueryPathElement>
    <RegistrationPathElement>String</RegistrationPathElement>
    <Selected>false</Selected>
    <Title>String</Title>
  </Node>
</ArrayOfNode>