Retrieve a assignment group.
The underlying data model where the item is retrieved from is defined in devilry.apps.core.models.AssignmentGroup. The Simplified API that the server forwards this request to is devilry.apps.examiner.simplified.SimplifiedAssignmentGroup.read().
GET /examiner/restfulsimplifiedassignmentgroup/id
Another example, this one uses the optional result_fieldgroups parameter.
GET /examiner/restfulsimplifiedassignmentgroup/id
{
result_fieldgroups: ["users", "assignment", "feedback", "period", "feedbackdelivery", "candidates", "feedback_rendered_view", "subject"]
}
The unique identifier of a assignment group. You will typically get this id in response from a search.
Optional request parameters are encoded as a JSON object and sent as the request body as shown in the example above.
A list of group names. Each group adds an additional set of fields to the resulting data. The following group names are available:
- users
Expands to the following fields:
- candidates__identifier
- Actual location of the field:
- devilry.apps.core.models.Candidate
- About the field:
- List of many values.
- Type
- List of strings
- assignment
Expands to the following fields:
- parentnode__long_name
- Actual location of the field:
- devilry.apps.core.models.Assignment
- About the field:
- A longer name, more descriptive than “Short name”. This is the name visible to students.
- Type
- String
- parentnode__short_name
- Actual location of the field:
- devilry.apps.core.models.Assignment
- About the field:
- Max 20 characters. Only numbers, lowercase characters, ‘_’ and ‘-‘.
- Type
- String
- parentnode__anonymous
- Actual location of the field:
- devilry.apps.core.models.Assignment
- About the field:
- Specifies if this assignment is anonymous.
- Type
- Boolean
- parentnode__delivery_types
- Actual location of the field:
- devilry.apps.core.models.Assignment
- About the field:
- This option controls what types of deliveries this assignment accepts. See docs for Delivery for documentation of accepted values.
- Type
- Integer
- parentnode__publishing_time
- Actual location of the field:
- devilry.apps.core.models.Assignment
- About the field:
- The time when the assignment is to be published (visible to students and examiners).
- Type
- DateTime string (YYYY-MM-DD hh:mm:ss)
- feedback
Expands to the following fields:
- feedback__points
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- Number of points given on this feedback.
- Type
- Integer
- feedback__grade
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- The rendered grade, such as “A” or “approved”.
- Type
- String
- feedback__is_passing_grade
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- Is this a passing grade?
- Type
- Boolean
- period
Expands to the following fields:
- parentnode__parentnode
- Actual location of the field:
- devilry.apps.core.models.Period
- About the field:
- Autogenerated identifier.
- Type
- Integer
- parentnode__parentnode__long_name
- Actual location of the field:
- devilry.apps.core.models.Period
- About the field:
- A longer name, more descriptive than “Short name”. This is the name visible to students.
- Type
- String
- parentnode__parentnode__short_name
- Actual location of the field:
- devilry.apps.core.models.Period
- About the field:
- Max 20 characters. Only numbers, lowercase characters, ‘_’ and ‘-‘.
- Type
- String
- feedbackdelivery
Expands to the following fields:
- feedback__delivery__number
- Actual location of the field:
- devilry.apps.core.models.Delivery
- About the field:
- The delivery-number within this assignment-group. This number is automatically incremented within each AssignmentGroup, starting from 1. Always unique within the assignment-group.
- Type
- Integer
- feedback__delivery__time_of_delivery
- Actual location of the field:
- devilry.apps.core.models.Delivery
- About the field:
- Holds the date and time the Delivery was uploaded.
- Type
- DateTime string (YYYY-MM-DD hh:mm:ss)
- feedback__delivery__delivery_type
- Actual location of the field:
- devilry.apps.core.models.Delivery
- About the field:
- 0: Electronic delivery, 1: Non-electronic delivery, 2: Alias delivery. Default: 0.
- Type
- Integer
- feedback__delivery__deadline
- Actual location of the field:
- devilry.apps.core.models.Deadline
- About the field:
- Autogenerated identifier.
- Type
- Integer
- candidates
- Expands to the following fields:
- feedback_rendered_view
Expands to the following fields:
- feedback__rendered_view
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- A rendered HTML version of the feedback, containing whatever the grade-editor chose to dump in this field.
- Type
- String
- subject
Expands to the following fields:
- parentnode__parentnode__parentnode
- Actual location of the field:
- devilry.apps.core.models.Subject
- About the field:
- Autogenerated identifier.
- Type
- Integer
- parentnode__parentnode__parentnode__long_name
- Actual location of the field:
- devilry.apps.core.models.Subject
- About the field:
- A longer name, more descriptive than “Short name”. This is the name visible to students.
- Type
- String
- parentnode__parentnode__parentnode__short_name
- Actual location of the field:
- devilry.apps.core.models.Subject
- About the field:
- Max 20 characters. Only numbers, lowercase characters, ‘_’ and ‘-‘.
- Type
- String
200 OK
{
id: 15,
name: "My example value",
is_open: true,
parentnode: 15,
feedback: 15,
latest_delivery_id: No example-value available for this field,
latest_deadline_id: No example-value available for this field,
latest_deadline_deadline: No example-value available for this field,
number_of_deliveries: No example-value available for this field
}
As long as the assignment group is deleted without an error, the response is HTTP 200 with the requested data in the body. The result always contains the following fields:
- id
- Actual location of the field:
- devilry.apps.core.models.AssignmentGroup
- About the field:
- Autogenerated identifier.
- Type
- Integer
- name
- Actual location of the field:
- devilry.apps.core.models.AssignmentGroup
- About the field:
- An optional name for the group. Typically used a project name on project assignments.
- Type
- String
- is_open
- Actual location of the field:
- devilry.apps.core.models.AssignmentGroup
- About the field:
- If this is checked, the group can add deliveries.
- Type
- Boolean
- parentnode
- Actual location of the field:
- devilry.apps.core.models.Assignment
- About the field:
- Autogenerated identifier.
- Type
- Integer
- feedback
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- Autogenerated identifier.
- Type
- Integer
- latest_delivery_id
- Actual location of the field:
- Generated from a query
- About the field:
- Generated from a query.
- Type
- unknown
- latest_deadline_id
- Actual location of the field:
- Generated from a query
- About the field:
- Generated from a query.
- Type
- unknown
- latest_deadline_deadline
- Actual location of the field:
- Generated from a query
- About the field:
- Generated from a query.
- Type
- unknown
- number_of_deliveries
- Actual location of the field:
- Generated from a query
- About the field:
- Generated from a query.
- Type
- unknown
However, there may be more fields if specified with the result_fieldgroups request parameter.
On errors, we respond with one of the HTTP Error status codes.