DigiOffice Gateway Web Services

<back to all web services

GetNavigationContext

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

Namespace Global

    Namespace IDB.API.DTO.General

        Public Partial Class CommonEntityIdentifier
            Public Overridable Property ID As String
            Public Overridable Property DisplayName As String
            Public Overridable Property EntityName As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Navigation

        Public Partial Class NavigationContext
            Public Overridable Property Title As String
            Public Overridable Property NavigationElements As List(Of CommonEntityIdentifier)
        End Class
    End Namespace

    Namespace IDB.API.DTO.Navigation.Operations

        Public Partial Class GetNavigationContext
            Public Overridable Property ViewID As Guid
            Public Overridable Property Path As String
        End Class
    End Namespace
End Namespace

VB.NET GetNavigationContext DTOs

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

HTTP + OTHER

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: dogw.klokgroep.nl 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Title":"String","NavigationElements":[{"ID":"String","DisplayName":"String","EntityName":"String"}]}