Cochrane+ App API

<back to all web services

Test

The following routes are available for this service:
GET/testSimple test method to confirm the services are working
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class Test
    {
        /**
        * An email address a test email will be sent to
        */
        @ApiMember(Description="An email address a test email will be sent to")
        public String smtp = null;
        
        public String getSmtp() { return smtp; }
        public Test setSmtp(String value) { this.smtp = value; return this; }
    }

    public static class TestResponse
    {
        public String environment = null;
        public HashMap<String,TestResult> tests = null;
        public Boolean wasSuccessful = null;
        public String db = null;
        
        public String getEnvironment() { return environment; }
        public TestResponse setEnvironment(String value) { this.environment = value; return this; }
        public HashMap<String,TestResult> getTests() { return tests; }
        public TestResponse setTests(HashMap<String,TestResult> value) { this.tests = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public TestResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public String getDb() { return db; }
        public TestResponse setDb(String value) { this.db = value; return this; }
    }

    public static class TestResult
    {
        public Boolean wasSuccessful = null;
        public String description = null;
        
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public TestResult setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public String getDescription() { return description; }
        public TestResult setDescription(String value) { this.description = value; return this; }
    }

}

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