GET api/v1/dashboards/{code}

Request Information

URI Parameters

Name	Description	Type	Additional information
code		string	Required

Body Parameters

None.

Response Information

Resource Description

SingleResultResponseOfDashboardDto

Name	Description	Type	Additional information
Meta		MetaSingleResult	None.
Notifications			None.

Response Formats

application/json, text/json

Sample:

{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "id": "33728ab7-8a4d-48ac-a6d8-79de5535cc9d",
    "code": "sample string 2",
    "widgets": [
      {
        "id": "f1099301-02c0-4b6f-b7a2-f3f635aaddde",
        "code": "sample string 1",
        "isFavorite": true,
        "order": 3,
        "templateName": "sample string 4"
      },
      {
        "id": "f1099301-02c0-4b6f-b7a2-f3f635aaddde",
        "code": "sample string 1",
        "isFavorite": true,
        "order": 3,
        "templateName": "sample string 4"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SingleResultResponseOfDashboardDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta />
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
    <d2p1:Code>sample string 2</d2p1:Code>
    <d2p1:Id>33728ab7-8a4d-48ac-a6d8-79de5535cc9d</d2p1:Id>
    <d2p1:Widgets>
      <d2p1:WidgetItemListDto>
        <d2p1:Code>sample string 1</d2p1:Code>
        <d2p1:Id>f1099301-02c0-4b6f-b7a2-f3f635aaddde</d2p1:Id>
        <d2p1:IsFavorite>true</d2p1:IsFavorite>
        <d2p1:Order>3</d2p1:Order>
        <d2p1:TemplateName>sample string 4</d2p1:TemplateName>
      </d2p1:WidgetItemListDto>
      <d2p1:WidgetItemListDto>
        <d2p1:Code>sample string 1</d2p1:Code>
        <d2p1:Id>f1099301-02c0-4b6f-b7a2-f3f635aaddde</d2p1:Id>
        <d2p1:IsFavorite>true</d2p1:IsFavorite>
        <d2p1:Order>3</d2p1:Order>
        <d2p1:TemplateName>sample string 4</d2p1:TemplateName>
      </d2p1:WidgetItemListDto>
    </d2p1:Widgets>
  </Result>
</SingleResultResponseOfDashboardDtoaM_S85dVU>