Cochrane+ App API

Test

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

import Foundation
import ServiceStack

public class Test : Codable
{
    /**
    * An email address a test email will be sent to
    */
    // @ApiMember(Description="An email address a test email will be sent to")
    public var smtp:String

    required public init(){}
}

public class TestResponse : Codable
{
    public var environment:String
    public var tests:[String:TestResult] = [:]
    public var wasSuccessful:Bool
    public var db:String

    required public init(){}
}

public class TestResult : Codable
{
    public var wasSuccessful:Bool
    public var Description:String

    required public init(){}
}

Swift 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>