POST api/ClientDashboard

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientDashboardMasterID	globally unique identifier	None.
Name	string	None.
Description	string	None.
ReportID	string	None.
WorkSpaceID	string	None.
Categories	Collection of Category	None.
ClientID	globally unique identifier	None.
ClientName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientDashboardMasterID": "45298140-ae29-4a43-87f9-26c2acfc05b0",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ReportID": "sample string 4",
  "WorkSpaceID": "sample string 5",
  "Categories": [
    {
      "CategoryName": "sample string 1",
      "CategoryID": "5697d832-da56-4713-a5a8-23147638f84d"
    },
    {
      "CategoryName": "sample string 1",
      "CategoryID": "5697d832-da56-4713-a5a8-23147638f84d"
    }
  ],
  "ClientID": "ca2233a2-b171-4bda-ab26-a923ab616804",
  "ClientName": "sample string 7"
}

application/xml, text/xml

Sample:

<CustomClientDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <Categories>
    <Category>
      <CategoryID>5697d832-da56-4713-a5a8-23147638f84d</CategoryID>
      <CategoryName>sample string 1</CategoryName>
    </Category>
    <Category>
      <CategoryID>5697d832-da56-4713-a5a8-23147638f84d</CategoryID>
      <CategoryName>sample string 1</CategoryName>
    </Category>
  </Categories>
  <ClientDashboardMasterID>45298140-ae29-4a43-87f9-26c2acfc05b0</ClientDashboardMasterID>
  <ClientID>ca2233a2-b171-4bda-ab26-a923ab616804</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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomClientDashboard

Name	Type	Additional information
ClientDashboardMasterID	globally unique identifier	None.
Name	string	None.
Description	string	None.
ReportID	string	None.
WorkSpaceID	string	None.
Categories	Collection of Category	None.
ClientID	globally unique identifier	None.
ClientName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientDashboardMasterID": "f3e37ea1-12db-4da6-9214-da9fac573522",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ReportID": "sample string 4",
  "WorkSpaceID": "sample string 5",
  "Categories": [
    {
      "CategoryName": "sample string 1",
      "CategoryID": "a042961f-2ed4-4922-b7fe-39df32449355"
    },
    {
      "CategoryName": "sample string 1",
      "CategoryID": "a042961f-2ed4-4922-b7fe-39df32449355"
    }
  ],
  "ClientID": "e2b9ce3c-f28f-4158-93ab-9a1f2eaf78b0",
  "ClientName": "sample string 7"
}

application/xml, text/xml

Sample:

<CustomClientDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <Categories>
    <Category>
      <CategoryID>a042961f-2ed4-4922-b7fe-39df32449355</CategoryID>
      <CategoryName>sample string 1</CategoryName>
    </Category>
    <Category>
      <CategoryID>a042961f-2ed4-4922-b7fe-39df32449355</CategoryID>
      <CategoryName>sample string 1</CategoryName>
    </Category>
  </Categories>
  <ClientDashboardMasterID>f3e37ea1-12db-4da6-9214-da9fac573522</ClientDashboardMasterID>
  <ClientID>e2b9ce3c-f28f-4158-93ab-9a1f2eaf78b0</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>