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 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 .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
				}
			]
		}
	]
}