Retrieve a Deadline.
The underlying data model where the item is retrieved from is defined in devilry.apps.core.models.Deadline. The Simplified API that the server forwards this request to is devilry.apps.student.simplified.SimplifiedDeadline.read().
GET /student/restfulsimplifieddeadline/id
Another example, this one uses the optional result_fieldgroups parameter.
GET /student/restfulsimplifieddeadline/id
{
result_fieldgroups: ["assignment", "assignment_group", "assignment_group_users", "period", "subject"]
}
The unique identifier of a Deadline. 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:
- assignment_group__parentnode__id
- Actual location of the field:
- devilry.apps.core.models.Assignment
- About the field:
- Autogenerated identifier.
- Type
- Integer
- assignment_group__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
- 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
- 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
- assignment_group
Expands to the following fields:
- 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
- assignment_group__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
- assignment_group_users
Expands to the following fields:
- 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
- period
Expands to the following fields:
- assignment_group__parentnode__parentnode__id
- Actual location of the field:
- devilry.apps.core.models.Period
- About the field:
- Autogenerated identifier.
- Type
- Integer
- 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
- 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
- subject
Expands to the following fields:
- assignment_group__parentnode__parentnode__parentnode__id
- Actual location of the field:
- devilry.apps.core.models.Subject
- About the field:
- Autogenerated identifier.
- Type
- Integer
- 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
- 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,
text: "myvalue",
deadline: "2010-02-22 22:32:10",
assignment_group: 15,
number_of_deliveries: No example-value available for this field,
feedbacks_published: true
}
As long as the Deadline 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.Deadline
- About the field:
- Autogenerated identifier.
- Type
- Integer
- text
- Actual location of the field:
- devilry.apps.core.models.Deadline
- About the field:
- An optional text to show to students and examiners.
- Type
- String
- deadline
- Actual location of the field:
- devilry.apps.core.models.Deadline
- About the field:
- The time of the deadline.
- Type
- DateTime string (YYYY-MM-DD hh:mm:ss)
- assignment_group
- Actual location of the field:
- devilry.apps.core.models.AssignmentGroup
- About the field:
- Autogenerated identifier.
- Type
- Integer
- number_of_deliveries
- Actual location of the field:
- Generated from a query
- About the field:
- Generated from a query.
- Type
- unknown
- feedbacks_published
- Actual location of the field:
- devilry.apps.core.models.Deadline
- About the field:
- If this is True, the student can see all StaticFeedbacks associated with this Deadline
- Type
- Boolean
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.