DigiOffice Gateway Web Services

AddGroup

The following routes are available for this service:
POST	/api/dashboards/{ID}/groups/add

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TileDto:
    id: Optional[str] = None
    group_i_d: Optional[str] = None
    type: int = 0
    name: Optional[str] = None
    order: int = 0
    cols: int = 0
    rows: int = 0
    style: int = 0
    data: Optional[str] = None
    font_awesome_icon: Optional[str] = None
    font_awesome_style: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TileGroupDto:
    id: Optional[str] = None
    dashboard_i_d: Optional[str] = None
    name: Optional[str] = None
    cols: int = 0
    rows: int = 0
    order: int = 0
    tiles: Optional[List[TileDto]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddGroup:
    id: Optional[str] = None
    group: Optional[TileGroupDto] = None

Python 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>