DigiOffice Gateway Web Services

<back to all web services

GetDashboard

Requires Authentication
The following routes are available for this service:
GET/api/dashboards/{ID}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Dashboard.Operations;
using IDB.API.DTO.Dashboard;

namespace IDB.API.DTO.Dashboard
{
    public partial class DashboardDto
    {
        public DashboardDto()
        {
            TileGroups = new List<TileGroupDto>{};
        }

        public virtual Guid ID { get; set; }
        public virtual int UserID { get; set; }
        public virtual List<TileGroupDto> TileGroups { get; set; }
    }

    public partial class TileDto
    {
        public virtual Guid ID { get; set; }
        public virtual Guid GroupID { get; set; }
        public virtual int Type { get; set; }
        public virtual string Name { get; set; }
        public virtual int Order { get; set; }
        public virtual int Cols { get; set; }
        public virtual int Rows { get; set; }
        public virtual int Style { get; set; }
        public virtual string Data { get; set; }
        public virtual string FontAwesomeIcon { get; set; }
        public virtual string FontAwesomeStyle { get; set; }
    }

    public partial class TileGroupDto
    {
        public TileGroupDto()
        {
            Tiles = new List<TileDto>{};
        }

        public virtual Guid ID { get; set; }
        public virtual Guid DashboardID { get; set; }
        public virtual string Name { get; set; }
        public virtual int Cols { get; set; }
        public virtual int Rows { get; set; }
        public virtual int Order { get; set; }
        public virtual List<TileDto> Tiles { get; set; }
    }

}

namespace IDB.API.DTO.Dashboard.Operations
{
    public partial class GetDashboard
    {
        public virtual Guid? ID { get; set; }
    }

}

C# GetDashboard DTOs

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

HTTP + CSV

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

{"ID":"00000000-0000-0000-0000-000000000000","UserID":0,"TileGroups":[{"ID":"00000000-0000-0000-0000-000000000000","DashboardID":"00000000-0000-0000-0000-000000000000","Name":"String","Cols":0,"Rows":0,"Order":0,"Tiles":[{"ID":"00000000-0000-0000-0000-000000000000","GroupID":"00000000-0000-0000-0000-000000000000","Type":0,"Name":"String","Order":0,"Cols":0,"Rows":0,"Style":0,"Data":"String","FontAwesomeIcon":"String","FontAwesomeStyle":"String"}]}]}