GET api/v{version}/laboratory/{laboratoryId}/dashboard

Request Information

URI Parameters

Name	Description	Type	Additional information
laboratoryId		integer	Required
version		string	None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfIEnumerableOfDashboardListItem

Name	Description	Type	Additional information
Data		Collection of DashboardListItem	None.
StatusCode	Gets or sets the status code.	HttpStatusCode	None.
StatusDescription	Gets or sets the status description.	string	None.
Errors		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "data": [
    {
      "dashboardID": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "laboratoryID": 4,
      "isSystemDefined": true,
      "management": true,
      "dashboardTypeID": 7,
      "privilege": 8.0,
      "isSubjectProfile": true,
      "isMedicalSummary": true,
      "subjectSelectable": true,
      "isMultiUserEditable": true
    },
    {
      "dashboardID": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "laboratoryID": 4,
      "isSystemDefined": true,
      "management": true,
      "dashboardTypeID": 7,
      "privilege": 8.0,
      "isSubjectProfile": true,
      "isMedicalSummary": true,
      "subjectSelectable": true,
      "isMultiUserEditable": true
    }
  ],
  "statusCode": 100,
  "statusDescription": "sample string 1",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfDashboardListItemuFpbgzW1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <StatusCode>Continue</StatusCode>
  <StatusDescription>sample string 1</StatusDescription>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/DomainObjects">
    <d2p1:DashboardListItem>
      <d2p1:DashboardID>1</d2p1:DashboardID>
      <d2p1:DashboardTypeID>7</d2p1:DashboardTypeID>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:IsMedicalSummary>true</d2p1:IsMedicalSummary>
      <d2p1:IsMultiUserEditable>true</d2p1:IsMultiUserEditable>
      <d2p1:IsSubjectProfile>true</d2p1:IsSubjectProfile>
      <d2p1:IsSystemDefined>true</d2p1:IsSystemDefined>
      <d2p1:LaboratoryID>4</d2p1:LaboratoryID>
      <d2p1:Management>true</d2p1:Management>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Privilege>8</d2p1:Privilege>
      <d2p1:SubjectSelectable>true</d2p1:SubjectSelectable>
    </d2p1:DashboardListItem>
    <d2p1:DashboardListItem>
      <d2p1:DashboardID>1</d2p1:DashboardID>
      <d2p1:DashboardTypeID>7</d2p1:DashboardTypeID>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:IsMedicalSummary>true</d2p1:IsMedicalSummary>
      <d2p1:IsMultiUserEditable>true</d2p1:IsMultiUserEditable>
      <d2p1:IsSubjectProfile>true</d2p1:IsSubjectProfile>
      <d2p1:IsSystemDefined>true</d2p1:IsSystemDefined>
      <d2p1:LaboratoryID>4</d2p1:LaboratoryID>
      <d2p1:Management>true</d2p1:Management>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Privilege>8</d2p1:Privilege>
      <d2p1:SubjectSelectable>true</d2p1:SubjectSelectable>
    </d2p1:DashboardListItem>
  </Data>
</ResponseOfArrayOfDashboardListItemuFpbgzW1>