DigiOffice Gateway Web Services

GetDashboard

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

namespace IDB.API.DTO.Dashboard

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TileDto() = 
        member val ID:Guid = new Guid() with get,set
        member val GroupID:Guid = new Guid() with get,set
        member val Type:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Order:Int32 = new Int32() with get,set
        member val Cols:Int32 = new Int32() with get,set
        member val Rows:Int32 = new Int32() with get,set
        member val Style:Int32 = new Int32() with get,set
        member val Data:String = null with get,set
        member val FontAwesomeIcon:String = null with get,set
        member val FontAwesomeStyle:String = null with get,set

    [<AllowNullLiteral>]
    type TileGroupDto() = 
        member val ID:Guid = new Guid() with get,set
        member val DashboardID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Cols:Int32 = new Int32() with get,set
        member val Rows:Int32 = new Int32() with get,set
        member val Order:Int32 = new Int32() with get,set
        member val Tiles:ResizeArray<TileDto> = new ResizeArray<TileDto>() with get,set

    [<AllowNullLiteral>]
    type DashboardDto() = 
        member val ID:Guid = new Guid() with get,set
        member val UserID:Int32 = new Int32() with get,set
        member val TileGroups:ResizeArray<TileGroupDto> = new ResizeArray<TileGroupDto>() with get,set

    [<AllowNullLiteral>]
    type GetDashboard() = 
        member val ID:Nullable<Guid> = new Nullable<Guid>() with get,set

F# GetDashboard DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}]}