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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestResult:
    was_successful: bool = False
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestResponse:
    environment: Optional[str] = None
    tests: Optional[Dict[str, TestResult]] = None
    was_successful: bool = False
    db: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Test:
    # @ApiMember(Description="An email address a test email will be sent to")
    smtp: Optional[str] = None
    """
    An email address a test email will be sent to
    """

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