DigiOffice Gateway Web Services

GetDashboard

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

import Foundation
import ServiceStack

public class GetDashboard : Codable
{
    public var id:String?

    required public init(){}
}

public class DashboardDto : Codable
{
    public var id:String?
    public var userID:Int?
    public var tileGroups:[TileGroupDto] = []

    required public init(){}
}

public class TileGroupDto : Codable
{
    public var id:String?
    public var dashboardID:String?
    public var name:String?
    public var cols:Int?
    public var rows:Int?
    public var order:Int?
    public var tiles:[TileDto] = []

    required public init(){}
}

public class TileDto : Codable
{
    public var id:String?
    public var groupID:String?
    public var type:Int?
    public var name:String?
    public var order:Int?
    public var cols:Int?
    public var rows:Int?
    public var style:Int?
    public var data:String?
    public var fontAwesomeIcon:String?
    public var fontAwesomeStyle:String?

    required public init(){}
}

Swift 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>