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

HTTP + XML

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

<Compile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Algomate.API.ServiceModel">
  <Authorization>String</Authorization>
  <ScriptText>String</ScriptText>
</Compile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompilationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Algomate.Scripting">
  <Diagnostics>
    <CompilationDiagnostic>
      <Id>String</Id>
      <Location>String</Location>
      <Message>String</Message>
      <Raw>String</Raw>
      <Severity>Hidden</Severity>
    </CompilationDiagnostic>
  </Diagnostics>
  <Success>false</Success>
</CompilationResult>