WebApi

<back to all web services

CompileScript

Compiles an existing script by ID

The following routes are available for this service:
POST, OPTIONS/Scripts/{ScriptId}/compile
CompileScript Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
ScriptIdpathstringYesScript ID
Script Parameters:
NameParameterData TypeRequiredDescription
ScriptIdformstringNo
NameformstringNo
TextformstringNo
StateformScriptStateNo
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 .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/{ScriptId}/compile HTTP/1.1 
Host: burntrouter.info 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

{"ScriptId":"String","Name":"String","Text":"String","State":"Active","Result":{"Success":false,"Diagnostics":[{"Id":"String","Severity":"Hidden","Location":"String","Message":"String","Raw":"String"}]}}