DigiOffice API Services 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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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