GET api/v1/dashboards

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Limit	integer	None.
Offset	integer	None.
OrderBy	string	None.

Request Formats

application/json, text/json

Sample:

{
  "limit": 1,
  "offset": 2,
  "orderBy": "sample string 3"
}

application/xml, text/xml

Sample:

<MultiResultRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos">
  <Limit>1</Limit>
  <Offset>2</Offset>
  <OrderBy>sample string 3</OrderBy>
</MultiResultRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MultiResultResponseOfDashboardDto

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

Response Formats

application/json, text/json

Sample:

{
  "meta": {
    "limit": 1,
    "offset": 2,
    "totalResults": 3
  },
  "notifications": [
    {},
    {}
  ],
  "results": [
    {
      "id": "4a49a4e9-91a2-403c-8da5-49f25017cfb9",
      "code": "sample string 2",
      "widgets": [
        {
          "id": "6f2ef550-4266-46a0-b882-4cb31a023b8a",
          "code": "sample string 1",
          "isFavorite": true,
          "order": 3,
          "templateName": "sample string 4"
        },
        {
          "id": "6f2ef550-4266-46a0-b882-4cb31a023b8a",
          "code": "sample string 1",
          "isFavorite": true,
          "order": 3,
          "templateName": "sample string 4"
        }
      ]
    },
    {
      "id": "4a49a4e9-91a2-403c-8da5-49f25017cfb9",
      "code": "sample string 2",
      "widgets": [
        {
          "id": "6f2ef550-4266-46a0-b882-4cb31a023b8a",
          "code": "sample string 1",
          "isFavorite": true,
          "order": 3,
          "templateName": "sample string 4"
        },
        {
          "id": "6f2ef550-4266-46a0-b882-4cb31a023b8a",
          "code": "sample string 1",
          "isFavorite": true,
          "order": 3,
          "templateName": "sample string 4"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<MultiResultResponseOfDashboardDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta>
    <Limit>1</Limit>
    <Offset>2</Offset>
    <TotalResults>3</TotalResults>
  </Meta>
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
    <d2p1:DashboardDto>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:Id>4a49a4e9-91a2-403c-8da5-49f25017cfb9</d2p1:Id>
      <d2p1:Widgets>
        <d2p1:WidgetItemListDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:Id>6f2ef550-4266-46a0-b882-4cb31a023b8a</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>6f2ef550-4266-46a0-b882-4cb31a023b8a</d2p1:Id>
          <d2p1:IsFavorite>true</d2p1:IsFavorite>
          <d2p1:Order>3</d2p1:Order>
          <d2p1:TemplateName>sample string 4</d2p1:TemplateName>
        </d2p1:WidgetItemListDto>
      </d2p1:Widgets>
    </d2p1:DashboardDto>
    <d2p1:DashboardDto>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:Id>4a49a4e9-91a2-403c-8da5-49f25017cfb9</d2p1:Id>
      <d2p1:Widgets>
        <d2p1:WidgetItemListDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:Id>6f2ef550-4266-46a0-b882-4cb31a023b8a</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>6f2ef550-4266-46a0-b882-4cb31a023b8a</d2p1:Id>
          <d2p1:IsFavorite>true</d2p1:IsFavorite>
          <d2p1:Order>3</d2p1:Order>
          <d2p1:TemplateName>sample string 4</d2p1:TemplateName>
        </d2p1:WidgetItemListDto>
      </d2p1:Widgets>
    </d2p1:DashboardDto>
  </Results>
</MultiResultResponseOfDashboardDtoaM_S85dVU>