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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"Authorization":"String","ScriptText":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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