| POST, OPTIONS | /Scripts |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | Yes | Authorization token in the form "Bearer your_token_here" |
| Name | body | string | Yes | A user supplied, arbitrary, name for the script |
| ScriptText | body | string | Yes | Script text |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ScriptId | form | string | No | |
| Name | form | string | No | |
| Text | form | string | No | |
| State | form | ScriptState | No | |
| Result | form | CompilationResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Diagnostics | form | List<CompilationDiagnostic> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Scripts HTTP/1.1
Host: partytime.pt
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Authorization: String,
Name: String,
ScriptText: 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
}
]
}
}