GET | /status | Verify that the service runs correctly. | The reply itself is a verification of success, and causes a warmup, furthermore contact with database and other required services is checked. |
---|
export module ConsumerApi
{
// @ts-nocheck
export class StatusResponse
{
public databaseConnectionOk?: boolean;
public searchConnectionOk?: boolean;
public deployedVersion: string;
public deployedAt?: string;
public constructor(init?: Partial<StatusResponse>) { (Object as any).assign(this, init); }
}
export class StatusRequest implements IGet
{
public constructor(init?: Partial<StatusRequest>) { (Object as any).assign(this, init); }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /status HTTP/1.1 Host: unstable-consumer-api.brovs.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"databaseConnectionOk":false,"searchConnectionOk":false,"deployedVersion":"String","deployedAt":"0001-01-01T00:00:00.0000000+00:00"}