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

export class TileDto
{
    public ID: string;
    public GroupID: string;
    public Type: number;
    public Name: string;
    public Order: number;
    public Cols: number;
    public Rows: number;
    public Style: number;
    public Data: string;
    public FontAwesomeIcon: string;
    public FontAwesomeStyle: string;

    public constructor(init?: Partial<TileDto>) { (Object as any).assign(this, init); }
}

export class TileGroupDto
{
    public ID: string;
    public DashboardID: string;
    public Name: string;
    public Cols: number;
    public Rows: number;
    public Order: number;
    public Tiles: TileDto[];

    public constructor(init?: Partial<TileGroupDto>) { (Object as any).assign(this, init); }
}

export class AddGroup
{
    public ID: string;
    public Group: TileGroupDto;

    public constructor(init?: Partial<AddGroup>) { (Object as any).assign(this, init); }
}

TypeScript AddGroup 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.

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

{
	Group: 
	{
		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
			}
		]
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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