DigiOffice API Services Services

GetNavigators

The following routes are available for this service:
GET	/api/views/{ViewId}/explorers/{ExplorerId}/navigators
GET	/api/documentviews/{ViewId}/explorers/{ExplorerId}/navigators

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class GetNavigators implements ISearchCriteria, JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ViewId='',
        /** @var string */
        public string $ExplorerId='',
        /** @var string|null */
        public ?string $Path=null,
        /** @var string|null */
        public ?string $NodeExplorerID=null,
        /** @var string|null */
        public ?string $SearchCriteria=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ViewId'])) $this->ViewId = $o['ViewId'];
        if (isset($o['ExplorerId'])) $this->ExplorerId = $o['ExplorerId'];
        if (isset($o['Path'])) $this->Path = $o['Path'];
        if (isset($o['NodeExplorerID'])) $this->NodeExplorerID = $o['NodeExplorerID'];
        if (isset($o['SearchCriteria'])) $this->SearchCriteria = $o['SearchCriteria'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ViewId)) $o['ViewId'] = $this->ViewId;
        if (isset($this->ExplorerId)) $o['ExplorerId'] = $this->ExplorerId;
        if (isset($this->Path)) $o['Path'] = $this->Path;
        if (isset($this->NodeExplorerID)) $o['NodeExplorerID'] = $this->NodeExplorerID;
        if (isset($this->SearchCriteria)) $o['SearchCriteria'] = $this->SearchCriteria;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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: test-do-services.klokgroep.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>