Cochrane+ App API

Test

The following routes are available for this service:
GET	/test	Simple test method to confirm the services are working


export class TestResult
{
    public wasSuccessful: boolean;
    public description: string;

    public constructor(init?: Partial<TestResult>) { (Object as any).assign(this, init); }
}

export class TestResponse
{
    public environment: string;
    public tests: { [index: string]: TestResult; };
    public wasSuccessful: boolean;
    public db: string;

    public constructor(init?: Partial<TestResponse>) { (Object as any).assign(this, init); }
}

export class Test
{
    /** @description An email address a test email will be sent to */
    // @ApiMember(Description="An email address a test email will be sent to")
    public smtp: string;

    public constructor(init?: Partial<Test>) { (Object as any).assign(this, init); }
}

TypeScript Test DTOs

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

HTTP + JSON

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

GET /test HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json

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

{"environment":"String","tests":{"String":{"wasSuccessful":false,"description":"String"}},"wasSuccessful":false,"db":"String"}