Cochrane+ App API

Test

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

"use strict";
export class TestResult {
    /** @param {{wasSuccessful?:boolean,description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    wasSuccessful;
    /** @type {string} */
    description;
}
export class TestResponse {
    /** @param {{environment?:string,tests?:{ [index: string]: TestResult; },wasSuccessful?:boolean,db?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    environment;
    /** @type {{ [index: string]: TestResult; }} */
    tests;
    /** @type {boolean} */
    wasSuccessful;
    /** @type {string} */
    db;
}
export class Test {
    /** @param {{smtp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description An email address a test email will be sent to */
    smtp;
}

JavaScript Test DTOs

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 /test HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml

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

<TestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <DB>String</DB>
  <Environment>String</Environment>
  <Tests xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringTestResultQA0sK3Sx>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <Description>String</Description>
        <WasSuccessful>false</WasSuccessful>
      </d2p1:Value>
    </d2p1:KeyValueOfstringTestResultQA0sK3Sx>
  </Tests>
</TestResponse>