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
namespace IDB.API.DTO.Dashboard

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TileDto() = 
        member val ID:Guid = new Guid() with get,set
        member val GroupID:Guid = new Guid() with get,set
        member val Type:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Order:Int32 = new Int32() with get,set
        member val Cols:Int32 = new Int32() with get,set
        member val Rows:Int32 = new Int32() with get,set
        member val Style:Int32 = new Int32() with get,set
        member val Data:String = null with get,set
        member val FontAwesomeIcon:String = null with get,set
        member val FontAwesomeStyle:String = null with get,set

    [<AllowNullLiteral>]
    type TileGroupDto() = 
        member val ID:Guid = new Guid() with get,set
        member val DashboardID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Cols:Int32 = new Int32() with get,set
        member val Rows:Int32 = new Int32() with get,set
        member val Order:Int32 = new Int32() with get,set
        member val Tiles:ResizeArray<TileDto> = new ResizeArray<TileDto>() with get,set

    [<AllowNullLiteral>]
    type UpdateGroup() = 
        member val ID:Guid = new Guid() with get,set
        member val Group:TileGroupDto = null with get,set

F# 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: 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
		}
	]
}