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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;

namespace WebService.ServiceModel
{
    public partial class Test
    {
        ///<summary>
        ///An email address a test email will be sent to
        ///</summary>
        [ApiMember(Description="An email address a test email will be sent to")]
        public virtual string Smtp { get; set; }
    }

    public partial class TestResponse
    {
        public TestResponse()
        {
            Tests = new Dictionary<string, TestResult>{};
        }

        public virtual string Environment { get; set; }
        public virtual Dictionary<string, TestResult> Tests { get; set; }
        public virtual bool WasSuccessful { get; set; }
        public virtual string DB { get; set; }
    }

    public partial class TestResult
    {
        public virtual bool WasSuccessful { get; set; }
        public virtual string Description { get; set; }
    }

}

C# Test DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	environment: String,
	tests: 
	{
		String: 
		{
			wasSuccessful: False,
			description: String
		}
	},
	wasSuccessful: False,
	db: String
}