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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class TileDto implements IConvertible
{
    String? ID;
    String? GroupID;
    int? Type;
    String? Name;
    int? Order;
    int? Cols;
    int? Rows;
    int? Style;
    String? Data;
    String? FontAwesomeIcon;
    String? FontAwesomeStyle;

    TileDto({this.ID,this.GroupID,this.Type,this.Name,this.Order,this.Cols,this.Rows,this.Style,this.Data,this.FontAwesomeIcon,this.FontAwesomeStyle});
    TileDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        GroupID = json['GroupID'];
        Type = json['Type'];
        Name = json['Name'];
        Order = json['Order'];
        Cols = json['Cols'];
        Rows = json['Rows'];
        Style = json['Style'];
        Data = json['Data'];
        FontAwesomeIcon = json['FontAwesomeIcon'];
        FontAwesomeStyle = json['FontAwesomeStyle'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'GroupID': GroupID,
        'Type': Type,
        'Name': Name,
        'Order': Order,
        'Cols': Cols,
        'Rows': Rows,
        'Style': Style,
        'Data': Data,
        'FontAwesomeIcon': FontAwesomeIcon,
        'FontAwesomeStyle': FontAwesomeStyle
    };

    getTypeName() => "TileDto";
    TypeContext? context = _ctx;
}

class TileGroupDto implements IConvertible
{
    String? ID;
    String? DashboardID;
    String? Name;
    int? Cols;
    int? Rows;
    int? Order;
    List<TileDto>? Tiles;

    TileGroupDto({this.ID,this.DashboardID,this.Name,this.Cols,this.Rows,this.Order,this.Tiles});
    TileGroupDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        DashboardID = json['DashboardID'];
        Name = json['Name'];
        Cols = json['Cols'];
        Rows = json['Rows'];
        Order = json['Order'];
        Tiles = JsonConverters.fromJson(json['Tiles'],'List<TileDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'DashboardID': DashboardID,
        'Name': Name,
        'Cols': Cols,
        'Rows': Rows,
        'Order': Order,
        'Tiles': JsonConverters.toJson(Tiles,'List<TileDto>',context!)
    };

    getTypeName() => "TileGroupDto";
    TypeContext? context = _ctx;
}

class UpdateGroup implements IConvertible
{
    String? ID;
    TileGroupDto? Group;

    UpdateGroup({this.ID,this.Group});
    UpdateGroup.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        Group = JsonConverters.fromJson(json['Group'],'TileGroupDto',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'Group': JsonConverters.toJson(Group,'TileGroupDto',context!)
    };

    getTypeName() => "UpdateGroup";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'doapigw.baasbv.nl', types: <String, TypeInfo> {
    'TileDto': TypeInfo(TypeOf.Class, create:() => TileDto()),
    'TileGroupDto': TypeInfo(TypeOf.Class, create:() => TileGroupDto()),
    'List<TileDto>': TypeInfo(TypeOf.Class, create:() => <TileDto>[]),
    'UpdateGroup': TypeInfo(TypeOf.Class, create:() => UpdateGroup()),
});

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

PATCH /api/groups/{ID}/update HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateGroup 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>
</UpdateGroup>
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>