DigiOffice Gateway Web Services

<back to all web services

UpdateGroup

Requires Authentication
The following routes are available for this service:
PATCH/api/groups/{ID}/update
"use strict";
export class TileDto {
    /** @param {{ID?:string,GroupID?:string,Type?:number,Name?:string,Order?:number,Cols?:number,Rows?:number,Style?:number,Data?:string,FontAwesomeIcon?:string,FontAwesomeStyle?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    GroupID;
    /** @type {number} */
    Type;
    /** @type {string} */
    Name;
    /** @type {number} */
    Order;
    /** @type {number} */
    Cols;
    /** @type {number} */
    Rows;
    /** @type {number} */
    Style;
    /** @type {string} */
    Data;
    /** @type {string} */
    FontAwesomeIcon;
    /** @type {string} */
    FontAwesomeStyle;
}
export class TileGroupDto {
    /** @param {{ID?:string,DashboardID?:string,Name?:string,Cols?:number,Rows?:number,Order?:number,Tiles?:TileDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    DashboardID;
    /** @type {string} */
    Name;
    /** @type {number} */
    Cols;
    /** @type {number} */
    Rows;
    /** @type {number} */
    Order;
    /** @type {TileDto[]} */
    Tiles;
}
export class UpdateGroup {
    /** @param {{ID?:string,Group?:TileGroupDto}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {TileGroupDto} */
    Group;
}

JavaScript UpdateGroup 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.

PATCH /api/groups/{ID}/update HTTP/1.1 
Host: test-dogw.klokgroep.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
		}
	]
}