DigiOffice Gateway Web Services

<back to all web services

GetDashboard

Requires Authentication
The following routes are available for this service:
GET/api/dashboards/{ID}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetDashboard
{
    var ID:UUID? = null
}

open class DashboardDto
{
    var ID:UUID? = null
    var UserID:Int? = null
    var TileGroups:ArrayList<TileGroupDto> = ArrayList<TileGroupDto>()
}

open class TileGroupDto
{
    var ID:UUID? = null
    var DashboardID:UUID? = null
    var Name:String? = null
    var Cols:Int? = null
    var Rows:Int? = null
    var Order:Int? = null
    var Tiles:ArrayList<TileDto> = ArrayList<TileDto>()
}

open class TileDto
{
    var ID:UUID? = null
    var GroupID:UUID? = null
    var Type:Int? = null
    var Name:String? = null
    var Order:Int? = null
    var Cols:Int? = null
    var Rows:Int? = null
    var Style:Int? = null
    var Data:String? = null
    var FontAwesomeIcon:String? = null
    var FontAwesomeStyle:String? = null
}

Kotlin GetDashboard DTOs

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

HTTP + 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
				}
			]
		}
	]
}