WebApi

<back to all web services

Compile

Performs C# compilation on given script text and returns any errors

The following routes are available for this service:
POST, OPTIONS/Scripts/Compile
POST, OPTIONS/compile
Compile Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
ScriptTextbodystringYesThe script that needs to be compiled
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.

POST /Scripts/Compile HTTP/1.1 
Host: burntrouter.info 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Authorization: String,
	ScriptText: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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