DigiOffice Gateway Web Services

<back to all web services

AddGroup

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

public class dtos
{

    public static class AddGroup
    {
        public UUID ID = null;
        public TileGroupDto Group = null;
        
        public UUID getId() { return ID; }
        public AddGroup setId(UUID value) { this.ID = value; return this; }
        public TileGroupDto getGroup() { return Group; }
        public AddGroup setGroup(TileGroupDto value) { this.Group = value; return this; }
    }

    public static class TileGroupDto
    {
        public UUID ID = null;
        public UUID DashboardID = null;
        public String Name = null;
        public Integer Cols = null;
        public Integer Rows = null;
        public Integer Order = null;
        public ArrayList<TileDto> Tiles = null;
        
        public UUID getId() { return ID; }
        public TileGroupDto setId(UUID value) { this.ID = value; return this; }
        public UUID getDashboardID() { return DashboardID; }
        public TileGroupDto setDashboardID(UUID value) { this.DashboardID = value; return this; }
        public String getName() { return Name; }
        public TileGroupDto setName(String value) { this.Name = value; return this; }
        public Integer getCols() { return Cols; }
        public TileGroupDto setCols(Integer value) { this.Cols = value; return this; }
        public Integer getRows() { return Rows; }
        public TileGroupDto setRows(Integer value) { this.Rows = value; return this; }
        public Integer getOrder() { return Order; }
        public TileGroupDto setOrder(Integer value) { this.Order = value; return this; }
        public ArrayList<TileDto> getTiles() { return Tiles; }
        public TileGroupDto setTiles(ArrayList<TileDto> value) { this.Tiles = value; return this; }
    }

    public static class TileDto
    {
        public UUID ID = null;
        public UUID GroupID = null;
        public Integer Type = null;
        public String Name = null;
        public Integer Order = null;
        public Integer Cols = null;
        public Integer Rows = null;
        public Integer Style = null;
        public String Data = null;
        public String FontAwesomeIcon = null;
        public String FontAwesomeStyle = null;
        
        public UUID getId() { return ID; }
        public TileDto setId(UUID value) { this.ID = value; return this; }
        public UUID getGroupID() { return GroupID; }
        public TileDto setGroupID(UUID value) { this.GroupID = value; return this; }
        public Integer getType() { return Type; }
        public TileDto setType(Integer value) { this.Type = value; return this; }
        public String getName() { return Name; }
        public TileDto setName(String value) { this.Name = value; return this; }
        public Integer getOrder() { return Order; }
        public TileDto setOrder(Integer value) { this.Order = value; return this; }
        public Integer getCols() { return Cols; }
        public TileDto setCols(Integer value) { this.Cols = value; return this; }
        public Integer getRows() { return Rows; }
        public TileDto setRows(Integer value) { this.Rows = value; return this; }
        public Integer getStyle() { return Style; }
        public TileDto setStyle(Integer value) { this.Style = value; return this; }
        public String getData() { return Data; }
        public TileDto setData(String value) { this.Data = value; return this; }
        public String getFontAwesomeIcon() { return FontAwesomeIcon; }
        public TileDto setFontAwesomeIcon(String value) { this.FontAwesomeIcon = value; return this; }
        public String getFontAwesomeStyle() { return FontAwesomeStyle; }
        public TileDto setFontAwesomeStyle(String value) { this.FontAwesomeStyle = value; return this; }
    }

}

Java AddGroup DTOs

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.

POST /api/dashboards/{ID}/groups/add HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Dashboard.Operations">
  <Group xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Dashboard">
    <d2p1:Cols>0</d2p1:Cols>
    <d2p1:DashboardID>00000000-0000-0000-0000-000000000000</d2p1:DashboardID>
    <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Order>0</d2p1:Order>
    <d2p1:Rows>0</d2p1:Rows>
    <d2p1:Tiles>
      <d2p1:TileDto>
        <d2p1:Cols>0</d2p1:Cols>
        <d2p1:Data>String</d2p1:Data>
        <d2p1:FontAwesomeIcon>String</d2p1:FontAwesomeIcon>
        <d2p1:FontAwesomeStyle>String</d2p1:FontAwesomeStyle>
        <d2p1:GroupID>00000000-0000-0000-0000-000000000000</d2p1:GroupID>
        <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Order>0</d2p1:Order>
        <d2p1:Rows>0</d2p1:Rows>
        <d2p1:Style>0</d2p1:Style>
        <d2p1:Type>0</d2p1:Type>
      </d2p1:TileDto>
    </d2p1:Tiles>
  </Group>
  <ID>00000000-0000-0000-0000-000000000000</ID>
</AddGroup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TileGroupDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Dashboard">
  <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>