Retrieve a Period.
The underlying data model where the item is retrieved from is defined in devilry.apps.core.models.Period. The Simplified API that the server forwards this request to is devilry.apps.examiner.simplified.SimplifiedPeriod.read().
GET /examiner/restfulsimplifiedperiod/id
Another example, this one uses the optional result_fieldgroups parameter.
GET /examiner/restfulsimplifiedperiod/id
{
result_fieldgroups: ["subject"]
}
The unique identifier of a Period. 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:
- subject
Expands to the following fields:
- 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
- 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,
parentnode: 15,
short_name: "my_example001_value",
long_name: "My example value",
start_time: "2010-02-22 22:32:10",
end_time: "2010-02-22 22:32:10"
}
As long as the Period 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.Period
- About the field:
- Autogenerated identifier.
- Type
- Integer
- parentnode
- Actual location of the field:
- devilry.apps.core.models.Subject
- About the field:
- Autogenerated identifier.
- Type
- Integer
- 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
- 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
- start_time
- Actual location of the field:
- devilry.apps.core.models.Period
- About the field:
- Start time and end time defines when the period is active.
- Type
- DateTime string (YYYY-MM-DD hh:mm:ss)
- end_time
- Actual location of the field:
- devilry.apps.core.models.Period
- About the field:
- Start time and end time defines when the period is active.
- Type
- DateTime string (YYYY-MM-DD hh:mm:ss)
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.