WebApi

CompileScript

Compiles an existing script by ID

The following routes are available for this service:
POST, OPTIONS	/Scripts/{ScriptId}/compile

**CompileScript** Parameters:
Name	Parameter	Data Type	Required	Description
Authorization	header	string	Yes	Authorization token in the form "Bearer your_token_here"
ScriptId	path	string	Yes	Script ID

**Script** Parameters:
Name	Parameter	Data Type	Required
ScriptId	form	string	No
Name	form	string	No
Text	form	string	No
State	form	ScriptState	No
Result	form	CompilationResult	No

**CompilationResult** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Diagnostics	form	List<CompilationDiagnostic>	No

**CompilationDiagnostic** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Severity	form	CompilationDiagnosticSeverity	No
Location	form	string	No
Message	form	string	No
Raw	form	string	No

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/{ScriptId}/compile HTTP/1.1 
Host: partytime.pt 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Authorization: String,
	ScriptId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
			}
		]
	}
}