GET v1/Midnight/GetAPIStatus?MISKey={MISKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
MISKey

string

None.

Body Parameters

None.

Response Information

Resource Description

HealthCheckObject
NameDescriptionTypeAdditional information
isSuccessful

boolean

None.

error

string

None.

data

APIStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccessful": true,
  "error": "sample string 2",
  "data": {
    "DatabaseVersion": "sample string 1",
    "ConnectionToWS": "sample string 2",
    "ConnectionToMidnightDB": "sample string 3",
    "ErrorMessages": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<HealthCheckObject xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <isSuccessful>true</isSuccessful>
  <error>sample string 2</error>
  <data>
    <DatabaseVersion>sample string 1</DatabaseVersion>
    <ConnectionToWS>sample string 2</ConnectionToWS>
    <ConnectionToMidnightDB>sample string 3</ConnectionToMidnightDB>
    <ErrorMessages>sample string 4</ErrorMessages>
  </data>
</HealthCheckObject>