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
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { UserID: 0, TileGroups: [ { Name: String, Cols: 0, Rows: 0, Order: 0, Tiles: [ { Type: 0, Name: String, Order: 0, Cols: 0, Rows: 0, Style: 0, Data: String, FontAwesomeIcon: String, FontAwesomeStyle: String } ] } ] }