Retrieve the end-of-lab score report for a lab instance

Prev Next
Post
/GetScoreReport

The GetScoreReport command retrieves the end-of-lab score report for a specified lab instance.

Security
API Key: api_key
Header parameter nameapi_key

All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".

Query parameters
labinstanceid
integer (int64) Required

The unique identifier of the lab instance.

Example12345
format
string

The format in which to return the score report. Supported values are html and gzip. If omitted, the response defaults to html.

Valid values[ "html", "gzip" ]
Default"html"
Examplehtml
Responses
200

OK. The score report is returned in the requested format.

Headers
Content-Disposition
string
Returned only when `format` is `gzip`. Identifies the response as a file download named `{labinstanceid}-ScoreReport.html.gz`.
Exampleattachment; filename=66506663-ScoreReport.html.gz; filename*=UTF-8''66506663-ScoreReport.html.gz
"\n  Detailed Score Report...\n  \n    
Example Lab Name
\n
Congratulations, you passed!
\n ...\n \n\n"
string

The end-of-lab score report as an HTML document.

string (binary)

The end-of-lab score report as a gzip-compressed HTML file. When decompressed, the file contains the same HTML document returned by the html format.