WebApi

<back to all web services

SystemStatusCheck

Returns the status of the client's machine

The following routes are available for this service:
GET, OPTIONS/Status
SystemStatusCheck Parameters:
NameParameterData TypeRequiredDescription
ComponentquerystringNoThe component to check
SystemStatus Parameters:
NameParameterData TypeRequiredDescription
DatabaseStateformComponentStateNo
DatabaseMessageformstringNo
APIStateformComponentStateNo
APIMessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Status HTTP/1.1 
Host: burntrouter.info 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SystemStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Algomate.Scripting">
  <APIMessage>String</APIMessage>
  <APIState>Running</APIState>
  <DatabaseMessage>String</DatabaseMessage>
  <DatabaseState>Running</DatabaseState>
</SystemStatus>