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
Test Parameters:
NameParameterData TypeRequiredDescription
SmtpquerystringNoAn email address a test email will be sent to
TestResponse Parameters:
NameParameterData TypeRequiredDescription
EnvironmentformstringNo
TestsformDictionary<string, TestResult>No
WasSuccessfulformboolNo
DBformstringNo
TestResult Parameters:
NameParameterData TypeRequiredDescription
WasSuccessfulformboolNo
DescriptionformstringNo

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
}