DigiOffice Gateway Web Services

<back to all web services

GetDashboard

Requires Authentication
The following routes are available for this service:
GET/api/dashboards/{ID}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetDashboard
    {
        public UUID ID = null;
        
        public UUID getId() { return ID; }
        public GetDashboard setId(UUID value) { this.ID = value; return this; }
    }

    public static class DashboardDto
    {
        public UUID ID = null;
        public Integer UserID = null;
        public ArrayList<TileGroupDto> TileGroups = null;
        
        public UUID getId() { return ID; }
        public DashboardDto setId(UUID value) { this.ID = value; return this; }
        public Integer getUserID() { return UserID; }
        public DashboardDto setUserID(Integer value) { this.UserID = value; return this; }
        public ArrayList<TileGroupDto> getTileGroups() { return TileGroups; }
        public DashboardDto setTileGroups(ArrayList<TileGroupDto> value) { this.TileGroups = value; return this; }
    }

    public static class TileGroupDto
    {
        public UUID ID = null;
        public UUID DashboardID = null;
        public String Name = null;
        public Integer Cols = null;
        public Integer Rows = null;
        public Integer Order = null;
        public ArrayList<TileDto> Tiles = null;
        
        public UUID getId() { return ID; }
        public TileGroupDto setId(UUID value) { this.ID = value; return this; }
        public UUID getDashboardID() { return DashboardID; }
        public TileGroupDto setDashboardID(UUID value) { this.DashboardID = value; return this; }
        public String getName() { return Name; }
        public TileGroupDto setName(String value) { this.Name = value; return this; }
        public Integer getCols() { return Cols; }
        public TileGroupDto setCols(Integer value) { this.Cols = value; return this; }
        public Integer getRows() { return Rows; }
        public TileGroupDto setRows(Integer value) { this.Rows = value; return this; }
        public Integer getOrder() { return Order; }
        public TileGroupDto setOrder(Integer value) { this.Order = value; return this; }
        public ArrayList<TileDto> getTiles() { return Tiles; }
        public TileGroupDto setTiles(ArrayList<TileDto> value) { this.Tiles = value; return this; }
    }

    public static class TileDto
    {
        public UUID ID = null;
        public UUID GroupID = null;
        public Integer Type = null;
        public String Name = null;
        public Integer Order = null;
        public Integer Cols = null;
        public Integer Rows = null;
        public Integer Style = null;
        public String Data = null;
        public String FontAwesomeIcon = null;
        public String FontAwesomeStyle = null;
        
        public UUID getId() { return ID; }
        public TileDto setId(UUID value) { this.ID = value; return this; }
        public UUID getGroupID() { return GroupID; }
        public TileDto setGroupID(UUID value) { this.GroupID = value; return this; }
        public Integer getType() { return Type; }
        public TileDto setType(Integer value) { this.Type = value; return this; }
        public String getName() { return Name; }
        public TileDto setName(String value) { this.Name = value; return this; }
        public Integer getOrder() { return Order; }
        public TileDto setOrder(Integer value) { this.Order = value; return this; }
        public Integer getCols() { return Cols; }
        public TileDto setCols(Integer value) { this.Cols = value; return this; }
        public Integer getRows() { return Rows; }
        public TileDto setRows(Integer value) { this.Rows = value; return this; }
        public Integer getStyle() { return Style; }
        public TileDto setStyle(Integer value) { this.Style = value; return this; }
        public String getData() { return Data; }
        public TileDto setData(String value) { this.Data = value; return this; }
        public String getFontAwesomeIcon() { return FontAwesomeIcon; }
        public TileDto setFontAwesomeIcon(String value) { this.FontAwesomeIcon = value; return this; }
        public String getFontAwesomeStyle() { return FontAwesomeStyle; }
        public TileDto setFontAwesomeStyle(String value) { this.FontAwesomeStyle = value; return this; }
    }

}

Java 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"}]}]}