GET api/ClientDashboard?clientID={clientID}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of CustomDashboards

Name	Description	Type	Additional information
CategoryName		string	None.
Dashboards		Collection of CustomClientDashboard	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CategoryName": "sample string 1",
    "Dashboards": [
      {
        "ClientDashboardMasterID": "054dba8e-69b7-4572-a2d6-5496a221d435",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "ReportID": "sample string 4",
        "WorkSpaceID": "sample string 5",
        "Categories": [
          {
            "CategoryName": "sample string 1",
            "CategoryID": "bc2b7d79-427f-416c-901d-1331b94c664a"
          },
          {
            "CategoryName": "sample string 1",
            "CategoryID": "bc2b7d79-427f-416c-901d-1331b94c664a"
          }
        ],
        "ClientID": "ce631485-8442-4010-97ab-d858a2dc028d",
        "ClientName": "sample string 7"
      },
      {
        "ClientDashboardMasterID": "054dba8e-69b7-4572-a2d6-5496a221d435",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "ReportID": "sample string 4",
        "WorkSpaceID": "sample string 5",
        "Categories": [
          {
            "CategoryName": "sample string 1",
            "CategoryID": "bc2b7d79-427f-416c-901d-1331b94c664a"
          },
          {
            "CategoryName": "sample string 1",
            "CategoryID": "bc2b7d79-427f-416c-901d-1331b94c664a"
          }
        ],
        "ClientID": "ce631485-8442-4010-97ab-d858a2dc028d",
        "ClientName": "sample string 7"
      }
    ]
  },
  {
    "CategoryName": "sample string 1",
    "Dashboards": [
      {
        "ClientDashboardMasterID": "054dba8e-69b7-4572-a2d6-5496a221d435",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "ReportID": "sample string 4",
        "WorkSpaceID": "sample string 5",
        "Categories": [
          {
            "CategoryName": "sample string 1",
            "CategoryID": "bc2b7d79-427f-416c-901d-1331b94c664a"
          },
          {
            "CategoryName": "sample string 1",
            "CategoryID": "bc2b7d79-427f-416c-901d-1331b94c664a"
          }
        ],
        "ClientID": "ce631485-8442-4010-97ab-d858a2dc028d",
        "ClientName": "sample string 7"
      },
      {
        "ClientDashboardMasterID": "054dba8e-69b7-4572-a2d6-5496a221d435",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "ReportID": "sample string 4",
        "WorkSpaceID": "sample string 5",
        "Categories": [
          {
            "CategoryName": "sample string 1",
            "CategoryID": "bc2b7d79-427f-416c-901d-1331b94c664a"
          },
          {
            "CategoryName": "sample string 1",
            "CategoryID": "bc2b7d79-427f-416c-901d-1331b94c664a"
          }
        ],
        "ClientID": "ce631485-8442-4010-97ab-d858a2dc028d",
        "ClientName": "sample string 7"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomDashboards xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <CustomDashboards>
    <CategoryName>sample string 1</CategoryName>
    <Dashboards>
      <CustomClientDashboard>
        <Categories>
          <Category>
            <CategoryID>bc2b7d79-427f-416c-901d-1331b94c664a</CategoryID>
            <CategoryName>sample string 1</CategoryName>
          </Category>
          <Category>
            <CategoryID>bc2b7d79-427f-416c-901d-1331b94c664a</CategoryID>
            <CategoryName>sample string 1</CategoryName>
          </Category>
        </Categories>
        <ClientDashboardMasterID>054dba8e-69b7-4572-a2d6-5496a221d435</ClientDashboardMasterID>
        <ClientID>ce631485-8442-4010-97ab-d858a2dc028d</ClientID>
        <ClientName>sample string 7</ClientName>
        <Description>sample string 3</Description>
        <Name>sample string 2</Name>
        <ReportID>sample string 4</ReportID>
        <WorkSpaceID>sample string 5</WorkSpaceID>
      </CustomClientDashboard>
      <CustomClientDashboard>
        <Categories>
          <Category>
            <CategoryID>bc2b7d79-427f-416c-901d-1331b94c664a</CategoryID>
            <CategoryName>sample string 1</CategoryName>
          </Category>
          <Category>
            <CategoryID>bc2b7d79-427f-416c-901d-1331b94c664a</CategoryID>
            <CategoryName>sample string 1</CategoryName>
          </Category>
        </Categories>
        <ClientDashboardMasterID>054dba8e-69b7-4572-a2d6-5496a221d435</ClientDashboardMasterID>
        <ClientID>ce631485-8442-4010-97ab-d858a2dc028d</ClientID>
        <ClientName>sample string 7</ClientName>
        <Description>sample string 3</Description>
        <Name>sample string 2</Name>
        <ReportID>sample string 4</ReportID>
        <WorkSpaceID>sample string 5</WorkSpaceID>
      </CustomClientDashboard>
    </Dashboards>
  </CustomDashboards>
  <CustomDashboards>
    <CategoryName>sample string 1</CategoryName>
    <Dashboards>
      <CustomClientDashboard>
        <Categories>
          <Category>
            <CategoryID>bc2b7d79-427f-416c-901d-1331b94c664a</CategoryID>
            <CategoryName>sample string 1</CategoryName>
          </Category>
          <Category>
            <CategoryID>bc2b7d79-427f-416c-901d-1331b94c664a</CategoryID>
            <CategoryName>sample string 1</CategoryName>
          </Category>
        </Categories>
        <ClientDashboardMasterID>054dba8e-69b7-4572-a2d6-5496a221d435</ClientDashboardMasterID>
        <ClientID>ce631485-8442-4010-97ab-d858a2dc028d</ClientID>
        <ClientName>sample string 7</ClientName>
        <Description>sample string 3</Description>
        <Name>sample string 2</Name>
        <ReportID>sample string 4</ReportID>
        <WorkSpaceID>sample string 5</WorkSpaceID>
      </CustomClientDashboard>
      <CustomClientDashboard>
        <Categories>
          <Category>
            <CategoryID>bc2b7d79-427f-416c-901d-1331b94c664a</CategoryID>
            <CategoryName>sample string 1</CategoryName>
          </Category>
          <Category>
            <CategoryID>bc2b7d79-427f-416c-901d-1331b94c664a</CategoryID>
            <CategoryName>sample string 1</CategoryName>
          </Category>
        </Categories>
        <ClientDashboardMasterID>054dba8e-69b7-4572-a2d6-5496a221d435</ClientDashboardMasterID>
        <ClientID>ce631485-8442-4010-97ab-d858a2dc028d</ClientID>
        <ClientName>sample string 7</ClientName>
        <Description>sample string 3</Description>
        <Name>sample string 2</Name>
        <ReportID>sample string 4</ReportID>
        <WorkSpaceID>sample string 5</WorkSpaceID>
      </CustomClientDashboard>
    </Dashboards>
  </CustomDashboards>
</ArrayOfCustomDashboards>