DigiOffice Gateway Web Services

GetDashboard

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

"use strict";
export class TileDto {
    /** @param {{ID?:string,GroupID?:string,Type?:number,Name?:string,Order?:number,Cols?:number,Rows?:number,Style?:number,Data?:string,FontAwesomeIcon?:string,FontAwesomeStyle?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    GroupID;
    /** @type {number} */
    Type;
    /** @type {string} */
    Name;
    /** @type {number} */
    Order;
    /** @type {number} */
    Cols;
    /** @type {number} */
    Rows;
    /** @type {number} */
    Style;
    /** @type {string} */
    Data;
    /** @type {string} */
    FontAwesomeIcon;
    /** @type {string} */
    FontAwesomeStyle;
}
export class TileGroupDto {
    /** @param {{ID?:string,DashboardID?:string,Name?:string,Cols?:number,Rows?:number,Order?:number,Tiles?:TileDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    DashboardID;
    /** @type {string} */
    Name;
    /** @type {number} */
    Cols;
    /** @type {number} */
    Rows;
    /** @type {number} */
    Order;
    /** @type {TileDto[]} */
    Tiles;
}
export class DashboardDto {
    /** @param {{ID?:string,UserID?:number,TileGroups?:TileGroupDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {number} */
    UserID;
    /** @type {TileGroupDto[]} */
    TileGroups;
}
export class GetDashboard {
    constructor(init) { Object.assign(this, init) }
}

JavaScript 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 HTTP/1.1 
Host: test-dogw.klokgroep.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>