DigiOffice API Services Services

<back to all web services

GetNavigationContext

Requires Authentication
The following routes are available for this service:
GET/api/navigation/context
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Navigation.Operations;
using IDB.API.DTO.Navigation;
using IDB.API.DTO.General;

namespace IDB.API.DTO.General
{
    public partial class CommonEntityIdentifier
    {
        public virtual string ID { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual string EntityName { get; set; }
    }

}

namespace IDB.API.DTO.Navigation
{
    public partial class NavigationContext
    {
        public virtual string Title { get; set; }
        public virtual List<CommonEntityIdentifier> NavigationElements { get; set; }
    }

}

namespace IDB.API.DTO.Navigation.Operations
{
    public partial class GetNavigationContext
    {
        public virtual Guid ViewID { get; set; }
        public virtual string Path { get; set; }
    }

}

C# GetNavigationContext 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/navigation/context HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NavigationContext xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Navigation">
  <NavigationElements xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.General">
    <d2p1:CommonEntityIdentifier>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:EntityName>String</d2p1:EntityName>
      <d2p1:ID>String</d2p1:ID>
    </d2p1:CommonEntityIdentifier>
  </NavigationElements>
  <Title>String</Title>
</NavigationContext>