DigiOffice Gateway Web Services

GetDashboard

The following routes are available for this service:
GET	/api/dashboards/{ID}

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class TileDto implements IConvertible
{
    String? ID;
    String? GroupID;
    int? Type;
    String? Name;
    int? Order;
    int? Cols;
    int? Rows;
    int? Style;
    String? Data;
    String? FontAwesomeIcon;
    String? FontAwesomeStyle;

    TileDto({this.ID,this.GroupID,this.Type,this.Name,this.Order,this.Cols,this.Rows,this.Style,this.Data,this.FontAwesomeIcon,this.FontAwesomeStyle});
    TileDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        GroupID = json['GroupID'];
        Type = json['Type'];
        Name = json['Name'];
        Order = json['Order'];
        Cols = json['Cols'];
        Rows = json['Rows'];
        Style = json['Style'];
        Data = json['Data'];
        FontAwesomeIcon = json['FontAwesomeIcon'];
        FontAwesomeStyle = json['FontAwesomeStyle'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'GroupID': GroupID,
        'Type': Type,
        'Name': Name,
        'Order': Order,
        'Cols': Cols,
        'Rows': Rows,
        'Style': Style,
        'Data': Data,
        'FontAwesomeIcon': FontAwesomeIcon,
        'FontAwesomeStyle': FontAwesomeStyle
    };

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

class TileGroupDto implements IConvertible
{
    String? ID;
    String? DashboardID;
    String? Name;
    int? Cols;
    int? Rows;
    int? Order;
    List<TileDto>? Tiles;

    TileGroupDto({this.ID,this.DashboardID,this.Name,this.Cols,this.Rows,this.Order,this.Tiles});
    TileGroupDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        DashboardID = json['DashboardID'];
        Name = json['Name'];
        Cols = json['Cols'];
        Rows = json['Rows'];
        Order = json['Order'];
        Tiles = JsonConverters.fromJson(json['Tiles'],'List<TileDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'DashboardID': DashboardID,
        'Name': Name,
        'Cols': Cols,
        'Rows': Rows,
        'Order': Order,
        'Tiles': JsonConverters.toJson(Tiles,'List<TileDto>',context!)
    };

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

class DashboardDto implements IConvertible
{
    String? ID;
    int? UserID;
    List<TileGroupDto>? TileGroups;

    DashboardDto({this.ID,this.UserID,this.TileGroups});
    DashboardDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        UserID = json['UserID'];
        TileGroups = JsonConverters.fromJson(json['TileGroups'],'List<TileGroupDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'UserID': UserID,
        'TileGroups': JsonConverters.toJson(TileGroups,'List<TileGroupDto>',context!)
    };

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

class GetDashboard implements IConvertible
{
    String? ID;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'TileDto': TypeInfo(TypeOf.Class, create:() => TileDto()),
    'TileGroupDto': TypeInfo(TypeOf.Class, create:() => TileGroupDto()),
    'List<TileDto>': TypeInfo(TypeOf.Class, create:() => <TileDto>[]),
    'DashboardDto': TypeInfo(TypeOf.Class, create:() => DashboardDto()),
    'List<TileGroupDto>': TypeInfo(TypeOf.Class, create:() => <TileGroupDto>[]),
    'GetDashboard': TypeInfo(TypeOf.Class, create:() => GetDashboard()),
});

Dart GetDashboard 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/dashboards/{ID} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UserID: 0,
	TileGroups: 
	[
		{
			Name: String,
			Cols: 0,
			Rows: 0,
			Order: 0,
			Tiles: 
			[
				{
					Type: 0,
					Name: String,
					Order: 0,
					Cols: 0,
					Rows: 0,
					Style: 0,
					Data: String,
					FontAwesomeIcon: String,
					FontAwesomeStyle: String
				}
			]
		}
	]
}