DigiOffice Gateway Web Services

GetDashboard

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

**GetDashboard** Parameters:
Name	Parameter	Data Type	Required	Description
ID	path	Guid?	No

**DashboardDto** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid	No
UserID	form	int	No
TileGroups	form	List<TileGroupDto>	No

**TileGroupDto** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid	No
DashboardID	form	Guid	No
Name	form	string	No
Cols	form	int	No
Rows	form	int	No
Order	form	int	No
Tiles	form	List<TileDto>	No

**TileDto** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid	No
GroupID	form	Guid	No
Type	form	int	No
Name	form	string	No
Order	form	int	No
Cols	form	int	No
Rows	form	int	No
Style	form	int	No
Data	form	string	No
FontAwesomeIcon	form	string	No
FontAwesomeStyle	form	string	No

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

HTTP + XML

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Dashboard">
  <ID>00000000-0000-0000-0000-000000000000</ID>
  <TileGroups>
    <TileGroupDto>
      <Cols>0</Cols>
      <DashboardID>00000000-0000-0000-0000-000000000000</DashboardID>
      <ID>00000000-0000-0000-0000-000000000000</ID>
      <Name>String</Name>
      <Order>0</Order>
      <Rows>0</Rows>
      <Tiles>
        <TileDto>
          <Cols>0</Cols>
          <Data>String</Data>
          <FontAwesomeIcon>String</FontAwesomeIcon>
          <FontAwesomeStyle>String</FontAwesomeStyle>
          <GroupID>00000000-0000-0000-0000-000000000000</GroupID>
          <ID>00000000-0000-0000-0000-000000000000</ID>
          <Name>String</Name>
          <Order>0</Order>
          <Rows>0</Rows>
          <Style>0</Style>
          <Type>0</Type>
        </TileDto>
      </Tiles>
    </TileGroupDto>
  </TileGroups>
  <UserID>0</UserID>
</DashboardDto>