Retrieve a Static feedback.
The underlying data model where the item is retrieved from is defined in devilry.apps.core.models.StaticFeedback. The Simplified API that the server forwards this request to is devilry.apps.examiner.simplified.SimplifiedStaticFeedback.read().
GET /examiner/restfulsimplifiedstaticfeedback/id
Another example, this one uses the optional result_fieldgroups parameter.
GET /examiner/restfulsimplifiedstaticfeedback/id
{
result_fieldgroups: ["assignment", "period", "delivery", "candidates", "assignment_group", "subject"]
}
The unique identifier of a Static feedback. 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:
- assignment
Expands to the following fields:
- delivery__deadline__assignment_group__parentnode__id
- Actual location of the field:
- devilry.apps.core.models.Assignment
- About the field:
- Autogenerated identifier.
- Type
- Integer
- delivery__deadline__assignment_group__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
- delivery__deadline__assignment_group__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
- period
Expands to the following fields:
- delivery__deadline__assignment_group__parentnode__parentnode__id
- Actual location of the field:
- devilry.apps.core.models.Period
- About the field:
- Autogenerated identifier.
- Type
- Integer
- delivery__deadline__assignment_group__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
- delivery__deadline__assignment_group__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
- delivery
Expands to the following fields:
- 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)
- 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
- delivery__delivered_by
- Actual location of the field:
- devilry.apps.core.models.Candidate
- About the field:
- Autogenerated identifier.
- Type
- Integer
- candidates
Expands to the following fields:
- delivery__deadline__assignment_group__candidates__identifier
- Actual location of the field:
- devilry.apps.core.models.Candidate
- About the field:
- List of many values.
- Type
- List of strings
- assignment_group
Expands to the following fields:
- delivery__deadline__assignment_group
- Actual location of the field:
- devilry.apps.core.models.AssignmentGroup
- About the field:
- Autogenerated identifier.
- Type
- Integer
- delivery__deadline__assignment_group__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
- subject
Expands to the following fields:
- delivery__deadline__assignment_group__parentnode__parentnode__parentnode__id
- Actual location of the field:
- devilry.apps.core.models.Subject
- About the field:
- Autogenerated identifier.
- Type
- Integer
- delivery__deadline__assignment_group__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
- delivery__deadline__assignment_group__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
200 OK
{
id: 15,
grade: "My example value",
is_passing_grade: true,
saved_by: 15,
save_timestamp: "2010-02-22 22:32:10",
delivery: 15,
rendered_view: "myvalue",
points: 20
}
As long as the Static feedback 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.StaticFeedback
- About the field:
- Autogenerated identifier.
- Type
- Integer
- grade
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- The rendered grade, such as “A” or “approved”.
- Type
- String
- is_passing_grade
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- Is this a passing grade?
- Type
- Boolean
- saved_by
- Actual location of the field:
- django.contrib.auth.models.User
- About the field:
- Autogenerated identifier.
- Type
- Integer
- save_timestamp
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- Time when this feedback was saved. Since StaticFeedback is immutable, this never changes.
- Type
- DateTime string (YYYY-MM-DD hh:mm:ss)
- delivery
- Actual location of the field:
- devilry.apps.core.models.Delivery
- About the field:
- Autogenerated identifier.
- Type
- Integer
- 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
- points
- Actual location of the field:
- devilry.apps.core.models.StaticFeedback
- About the field:
- Number of points given on this feedback.
- Type
- Integer
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.