GET | /api/dashboards |
---|
export class TileDto
{
public ID: string;
public GroupID: string;
public Type: number;
public Name: string;
public Order: number;
public Cols: number;
public Rows: number;
public Style: number;
public Data: string;
public FontAwesomeIcon: string;
public FontAwesomeStyle: string;
public constructor(init?: Partial<TileDto>) { (Object as any).assign(this, init); }
}
export class TileGroupDto
{
public ID: string;
public DashboardID: string;
public Name: string;
public Cols: number;
public Rows: number;
public Order: number;
public Tiles: TileDto[];
public constructor(init?: Partial<TileGroupDto>) { (Object as any).assign(this, init); }
}
export class DashboardDto
{
public ID: string;
public UserID: number;
public TileGroups: TileGroupDto[];
public constructor(init?: Partial<DashboardDto>) { (Object as any).assign(this, init); }
}
export class GetDashboard
{
public constructor(init?: Partial<GetDashboard>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/dashboards HTTP/1.1 Host: doapigw.baasbv.nl Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <DashboardDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Dashboard"> <ID>00000000-0000-0000-0000-000000000000</ID> <TileGroups> <TileGroupDto> <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> </TileGroups> <UserID>0</UserID> </DashboardDto>