DigiOffice Gateway Web Services

<back to all web services

GetDashboard

Requires Authentication
The following routes are available for this service:
GET/api/dashboards

export class TileDto
{
    public ID: string;
    public GroupID: string;
    public Type: number;
    public Name: string;
    public Order: number;
    public Cols: number;
    public Rows: number;
    public Style: number;
    public Data: string;
    public FontAwesomeIcon: string;
    public FontAwesomeStyle: string;

    public constructor(init?: Partial<TileDto>) { (Object as any).assign(this, init); }
}

export class TileGroupDto
{
    public ID: string;
    public DashboardID: string;
    public Name: string;
    public Cols: number;
    public Rows: number;
    public Order: number;
    public Tiles: TileDto[];

    public constructor(init?: Partial<TileGroupDto>) { (Object as any).assign(this, init); }
}

export class DashboardDto
{
    public ID: string;
    public UserID: number;
    public TileGroups: TileGroupDto[];

    public constructor(init?: Partial<DashboardDto>) { (Object as any).assign(this, init); }
}

export class GetDashboard
{

    public constructor(init?: Partial<GetDashboard>) { (Object as any).assign(this, init); }
}

TypeScript GetDashboard 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/dashboards HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}]}