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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class CommonEntityIdentifier implements IConvertible
{
    String? ID;
    String? DisplayName;
    String? EntityName;

    CommonEntityIdentifier({this.ID,this.DisplayName,this.EntityName});
    CommonEntityIdentifier.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        DisplayName = json['DisplayName'];
        EntityName = json['EntityName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'DisplayName': DisplayName,
        'EntityName': EntityName
    };

    getTypeName() => "CommonEntityIdentifier";
    TypeContext? context = _ctx;
}

class NavigationContext implements IConvertible
{
    String? Title;
    List<CommonEntityIdentifier>? NavigationElements;

    NavigationContext({this.Title,this.NavigationElements});
    NavigationContext.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Title = json['Title'];
        NavigationElements = JsonConverters.fromJson(json['NavigationElements'],'List<CommonEntityIdentifier>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Title': Title,
        'NavigationElements': JsonConverters.toJson(NavigationElements,'List<CommonEntityIdentifier>',context!)
    };

    getTypeName() => "NavigationContext";
    TypeContext? context = _ctx;
}

class GetNavigationContext implements IConvertible
{
    String? ViewID;
    String? Path;

    GetNavigationContext({this.ViewID,this.Path});
    GetNavigationContext.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ViewID = json['ViewID'];
        Path = json['Path'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ViewID': ViewID,
        'Path': Path
    };

    getTypeName() => "GetNavigationContext";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'test_do_services.klokgroep.nl', types: <String, TypeInfo> {
    'CommonEntityIdentifier': TypeInfo(TypeOf.Class, create:() => CommonEntityIdentifier()),
    'NavigationContext': TypeInfo(TypeOf.Class, create:() => NavigationContext()),
    'List<CommonEntityIdentifier>': TypeInfo(TypeOf.Class, create:() => <CommonEntityIdentifier>[]),
    'GetNavigationContext': TypeInfo(TypeOf.Class, create:() => GetNavigationContext()),
});

Dart GetNavigationContext DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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