DigiOffice Gateway Web Services

GetDashboard

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 .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/dashboards/{ID} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Dashboard">
  <ID>00000000-0000-0000-0000-000000000000</ID>
  <TileGroups>
    <TileGroupDto>
      <Cols>0</Cols>
      <DashboardID>00000000-0000-0000-0000-000000000000</DashboardID>
      <ID>00000000-0000-0000-0000-000000000000</ID>
      <Name>String</Name>
      <Order>0</Order>
      <Rows>0</Rows>
      <Tiles>
        <TileDto>
          <Cols>0</Cols>
          <Data>String</Data>
          <FontAwesomeIcon>String</FontAwesomeIcon>
          <FontAwesomeStyle>String</FontAwesomeStyle>
          <GroupID>00000000-0000-0000-0000-000000000000</GroupID>
          <ID>00000000-0000-0000-0000-000000000000</ID>
          <Name>String</Name>
          <Order>0</Order>
          <Rows>0</Rows>
          <Style>0</Style>
          <Type>0</Type>
        </TileDto>
      </Tiles>
    </TileGroupDto>
  </TileGroups>
  <UserID>0</UserID>
</DashboardDto>