WebApi

<back to all web services

LoadBacktest

Fetches a particular backtest that belongs to a particular user

The following routes are available for this service:
GET, OPTIONS/Backtests/{UserId}/{Type}/{BacktestId}
LoadBacktest Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
UserIdpathstringYesBacktest owner User ID
TypepathstringYesBacktest type
BacktestIdpathstringYesBacktest ID
Backtest Parameters:
NameParameterData TypeRequiredDescription
BacktestIdformstringNo
ScriptIdformstringNo
NameformstringNo
ResultformCompilationResultNo
CompilationResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
DiagnosticsformList<CompilationDiagnostic>No
CompilationDiagnostic Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
SeverityformCompilationDiagnosticSeverityNo
LocationformstringNo
MessageformstringNo
RawformstringNo

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 /Backtests/{UserId}/{Type}/{BacktestId} HTTP/1.1 
Host: burntrouter.info 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BacktestId: String,
	ScriptId: String,
	Name: String,
	Result: 
	{
		Success: False,
		Diagnostics: 
		[
			{
				Id: String,
				Severity: Hidden,
				Location: String,
				Message: String,
				Raw: String
			}
		]
	}
}