DigiOffice Gateway Web Services

<back to all web services

GetNavigationContext

Requires Authentication
The following routes are available for this service:
GET/api/navigation/context
import Foundation
import ServiceStack

public class GetNavigationContext : Codable
{
    public var viewID:String
    public var path:String

    required public init(){}
}

public class NavigationContext : Codable
{
    public var title:String
    public var navigationElements:[CommonEntityIdentifier]

    required public init(){}
}

public class CommonEntityIdentifier : Codable
{
    public var id:String
    public var displayName:String
    public var entityName:String

    required public init(){}
}


Swift 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-dogw.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>