GET api/Dashboard

Returns the Current Status of all the services enrolled

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

SystemStatusResult
NameDescriptionTypeAdditional information
systemStatus

Collection of SystemStatusInfo

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "systemStatus": [
    {
      "ServiceId": 1,
      "ServiceName": "sample string 2",
      "Status": "sample string 3",
      "Description": "sample string 4"
    },
    {
      "ServiceId": 1,
      "ServiceName": "sample string 2",
      "Status": "sample string 3",
      "Description": "sample string 4"
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:
<SystemStatusResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <systemStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain">
    <d2p1:SystemStatusInfo>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:ServiceId>1</d2p1:ServiceId>
      <d2p1:ServiceName>sample string 2</d2p1:ServiceName>
      <d2p1:Status>sample string 3</d2p1:Status>
    </d2p1:SystemStatusInfo>
    <d2p1:SystemStatusInfo>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:ServiceId>1</d2p1:ServiceId>
      <d2p1:ServiceName>sample string 2</d2p1:ServiceName>
      <d2p1:Status>sample string 3</d2p1:Status>
    </d2p1:SystemStatusInfo>
  </systemStatus>
</SystemStatusResult>