| 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. |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class ConsumerApi
{
public static class StatusRequest implements IGet
{
}
public static class StatusResponse
{
public Boolean databaseConnectionOk = null;
public Boolean searchConnectionOk = null;
public String deployedVersion = null;
public Date deployedAt = null;
public Boolean isDatabaseConnectionOk() { return databaseConnectionOk; }
public StatusResponse setDatabaseConnectionOk(Boolean value) { this.databaseConnectionOk = value; return this; }
public Boolean isSearchConnectionOk() { return searchConnectionOk; }
public StatusResponse setSearchConnectionOk(Boolean value) { this.searchConnectionOk = value; return this; }
public String getDeployedVersion() { return deployedVersion; }
public StatusResponse setDeployedVersion(String value) { this.deployedVersion = value; return this; }
public Date getDeployedAt() { return deployedAt; }
public StatusResponse setDeployedAt(Date value) { this.deployedAt = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: unstable-consumer-api.brovs.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<StatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
<DatabaseConnectionOk>false</DatabaseConnectionOk>
<DeployedAt xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</DeployedAt>
<DeployedVersion>String</DeployedVersion>
<SearchConnectionOk>false</SearchConnectionOk>
</StatusResponse>