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 java.math.*
import java.util.*
import net.servicestack.client.*


open class UpdateGroup
{
    var ID:UUID? = null
    var Group:TileGroupDto? = null
}

open class TileGroupDto
{
    var ID:UUID? = null
    var DashboardID:UUID? = null
    var Name:String? = null
    var Cols:Int? = null
    var Rows:Int? = null
    var Order:Int? = null
    var Tiles:ArrayList<TileDto> = ArrayList<TileDto>()
}

open class TileDto
{
    var ID:UUID? = null
    var GroupID:UUID? = null
    var Type:Int? = null
    var Name:String? = null
    var Order:Int? = null
    var Cols:Int? = null
    var Rows:Int? = null
    var Style:Int? = null
    var Data:String? = null
    var FontAwesomeIcon:String? = null
    var FontAwesomeStyle:String? = null
}

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