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
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class TileDto implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ID='',
        /** @var string */
        public string $GroupID='',
        /** @var int */
        public int $Type=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var int */
        public int $Order=0,
        /** @var int */
        public int $Cols=0,
        /** @var int */
        public int $Rows=0,
        /** @var int */
        public int $Style=0,
        /** @var string|null */
        public ?string $Data=null,
        /** @var string|null */
        public ?string $FontAwesomeIcon=null,
        /** @var string|null */
        public ?string $FontAwesomeStyle=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['GroupID'])) $this->GroupID = $o['GroupID'];
        if (isset($o['Type'])) $this->Type = $o['Type'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Order'])) $this->Order = $o['Order'];
        if (isset($o['Cols'])) $this->Cols = $o['Cols'];
        if (isset($o['Rows'])) $this->Rows = $o['Rows'];
        if (isset($o['Style'])) $this->Style = $o['Style'];
        if (isset($o['Data'])) $this->Data = $o['Data'];
        if (isset($o['FontAwesomeIcon'])) $this->FontAwesomeIcon = $o['FontAwesomeIcon'];
        if (isset($o['FontAwesomeStyle'])) $this->FontAwesomeStyle = $o['FontAwesomeStyle'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->GroupID)) $o['GroupID'] = $this->GroupID;
        if (isset($this->Type)) $o['Type'] = $this->Type;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Order)) $o['Order'] = $this->Order;
        if (isset($this->Cols)) $o['Cols'] = $this->Cols;
        if (isset($this->Rows)) $o['Rows'] = $this->Rows;
        if (isset($this->Style)) $o['Style'] = $this->Style;
        if (isset($this->Data)) $o['Data'] = $this->Data;
        if (isset($this->FontAwesomeIcon)) $o['FontAwesomeIcon'] = $this->FontAwesomeIcon;
        if (isset($this->FontAwesomeStyle)) $o['FontAwesomeStyle'] = $this->FontAwesomeStyle;
        return empty($o) ? new class(){} : $o;
    }
}

class TileGroupDto implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ID='',
        /** @var string */
        public string $DashboardID='',
        /** @var string|null */
        public ?string $Name=null,
        /** @var int */
        public int $Cols=0,
        /** @var int */
        public int $Rows=0,
        /** @var int */
        public int $Order=0,
        /** @var array<TileDto>|null */
        public ?array $Tiles=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['DashboardID'])) $this->DashboardID = $o['DashboardID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Cols'])) $this->Cols = $o['Cols'];
        if (isset($o['Rows'])) $this->Rows = $o['Rows'];
        if (isset($o['Order'])) $this->Order = $o['Order'];
        if (isset($o['Tiles'])) $this->Tiles = JsonConverters::fromArray('TileDto', $o['Tiles']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->DashboardID)) $o['DashboardID'] = $this->DashboardID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Cols)) $o['Cols'] = $this->Cols;
        if (isset($this->Rows)) $o['Rows'] = $this->Rows;
        if (isset($this->Order)) $o['Order'] = $this->Order;
        if (isset($this->Tiles)) $o['Tiles'] = JsonConverters::toArray('TileDto', $this->Tiles);
        return empty($o) ? new class(){} : $o;
    }
}

class AddGroup implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ID='',
        /** @var TileGroupDto|null */
        public ?TileGroupDto $Group=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['Group'])) $this->Group = JsonConverters::from('TileGroupDto', $o['Group']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->Group)) $o['Group'] = JsonConverters::to('TileGroupDto', $this->Group);
        return empty($o) ? new class(){} : $o;
    }
}

PHP AddGroup DTOs

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

HTTP + CSV

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: dogw.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","Group":{"ID":"00000000-0000-0000-0000-000000000000","DashboardID":"00000000-0000-0000-0000-000000000000","Name":"String","Cols":0,"Rows":0,"Order":0,"Tiles":[{"ID":"00000000-0000-0000-0000-000000000000","GroupID":"00000000-0000-0000-0000-000000000000","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/csv
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","DashboardID":"00000000-0000-0000-0000-000000000000","Name":"String","Cols":0,"Rows":0,"Order":0,"Tiles":[{"ID":"00000000-0000-0000-0000-000000000000","GroupID":"00000000-0000-0000-0000-000000000000","Type":0,"Name":"String","Order":0,"Cols":0,"Rows":0,"Style":0,"Data":"String","FontAwesomeIcon":"String","FontAwesomeStyle":"String"}]}