Load Assignment Instance Endpoint

The GET /assignments/instance/{id} endpoint returns the details of the assignment instance with the given id.

Request

curl -X GET https://app.assignment-os.com/api/assignments/instance/{id} -H 'Authorization: apiKey 5a355e5a-8e1b-4dab-a17c-4ab49fc267c3' 

Response

For successful requests, the response code will be a 200 OK and the response body will be a JSON object with the following fields:

Field Name	JSON Data Type	Description
status	string	The status of this assignment instance. The possible values are in_progress and complete.
score	integer	The score this student achieved on this assignment, out of 100. Only present if the status is complete.
student_report_url	string	The automated analysis report for this assignment instance, to be shown to the student. Only present if the status is complete.

Example

Given the following request to this endpoint:

curl -X GET https://app.assignment-os.com/api/assignments/instance/67961167-20c6-4183-9b6b-6033ba61ba76 -H 'Authorization: apiKey 5a355e5a-8e1b-4dab-a17c-4ab49fc267c3' 

If the student has not completed the assignment yet, the response would be:

{
    "status": "in_progress"
}

If the student has completed the assignment, the response would be:

{
    "status": "complete",
    "score": 85,
    "student_report_url": "https://app.assignment-os.com/student-report/67961167-20c6-4183-9b6b-6033ba61ba76"
}