DigiOffice Gateway Web Services

<back to all web services

GetDashboard

Requires Authentication
The following routes are available for this service:
GET/api/dashboards/{ID}
GetDashboard Parameters:
NameParameterData TypeRequiredDescription
IDpathGuid?No
DashboardDto Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
UserIDformintNo
TileGroupsformList<TileGroupDto>No
TileGroupDto Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
DashboardIDformGuidNo
NameformstringNo
ColsformintNo
RowsformintNo
OrderformintNo
TilesformList<TileDto>No
TileDto Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
GroupIDformGuidNo
TypeformintNo
NameformstringNo
OrderformintNo
ColsformintNo
RowsformintNo
StyleformintNo
DataformstringNo
FontAwesomeIconformstringNo
FontAwesomeStyleformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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