Blackboard Authentication API

<back to all web services

HealthCheckRequest

The following routes are available for this service:
GET, OPTIONS/api/healthcheckReturns the health of the subsystems that this API relies on to function.

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.

POST /xml/reply/HealthCheckRequest HTTP/1.1 
Host: prodeastbbauthservice.transactcampus.com 
Content-Type: application/xml
Content-Length: length

<HealthCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BbAuth.Services.Host.Startup.HealthCheckApiRoutes.Models" />

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HealthCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BbAuth.Services.Host.Startup.HealthCheckApiRoutes.Models">
  <Systems>
    <HealthCheckItem>
      <Name>String</Name>
      <Status>Skip</Status>
    </HealthCheckItem>
  </Systems>
</HealthCheckResponse>