DigiOffice Gateway Web Services

GetDashboard

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Dashboard.Operations
Imports IDB.API.DTO.Dashboard

Namespace Global

    Namespace IDB.API.DTO.Dashboard

        Public Partial Class DashboardDto
            Public Sub New()
                TileGroups = New List(Of TileGroupDto)
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property UserID As Integer
            Public Overridable Property TileGroups As List(Of TileGroupDto)
        End Class

        Public Partial Class TileDto
            Public Overridable Property ID As Guid
            Public Overridable Property GroupID As Guid
            Public Overridable Property Type As Integer
            Public Overridable Property Name As String
            Public Overridable Property Order As Integer
            Public Overridable Property Cols As Integer
            Public Overridable Property Rows As Integer
            Public Overridable Property Style As Integer
            Public Overridable Property Data As String
            Public Overridable Property FontAwesomeIcon As String
            Public Overridable Property FontAwesomeStyle As String
        End Class

        Public Partial Class TileGroupDto
            Public Sub New()
                Tiles = New List(Of TileDto)
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property DashboardID As Guid
            Public Overridable Property Name As String
            Public Overridable Property Cols As Integer
            Public Overridable Property Rows As Integer
            Public Overridable Property Order As Integer
            Public Overridable Property Tiles As List(Of TileDto)
        End Class
    End Namespace

    Namespace IDB.API.DTO.Dashboard.Operations

        Public Partial Class GetDashboard
            Public Overridable Property ID As Nullable(Of Guid)
        End Class
    End Namespace
End Namespace

VB.NET 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>