Navigation

GET /examiner/restfulsimplifiedperiod/

Search for Periods.

The underlying data model searched is defined in devilry.apps.core.models.Period. The Simplified API that the server forwards this request to is devilry.apps.examiner.simplified.SimplifiedPeriod.search().

The request parameters (below) all modify the result of the search. They are applied in the following order:

  1. The query is executed.
  2. The result of the query is filtered through the filters.
  3. The result of the filtering is ordered as specified in orderby.
  4. The result of the ordering is limited by start and limit.

Request

Request example

GET /examiner/restfulsimplifiedperiod/

{
    query: 'a query string',
    filters: [{field:"end_time", comp:"exact", value:"2010-02-22 22:32:10"},
                  {field:"long_name", comp:">=", value:"My example value"},
                  {field:"parentnode", comp:"exact", value:15}],
    orderby: ["id", "-parentnode", "short_name", "long_name", "start_time", "end_time"],
    start: 10,
    limit: 100
}

Optional request parameters

Optional request parameters are encoded as a JSON object and sent as the request body as shown in the example above.

query

A string to search for. If this is empty or not given, all Periods that the authenticated user has access to is returned.

If the string is not empty, the query-string is split on whitespace, resulting in a list of words. Every word in the list is searched for case-insensitive matches within the following fields:

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
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

filters

Filters can be used to perform complex queries. The filters parameter is a list of filters, where each filter is a map with the following entries:

field
A field name.
comp
A comparison operator.
value
The value to filter on.

Example:

[{field:"end_time", comp:"exact", value:"2010-02-22 22:32:10"},
 {field:"long_name", comp:">=", value:"My example value"},
 {field:"parentnode", comp:"exact", value:15}]

Periods can be filtered on the following fields:

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)
Supported comparison operators:
startswith, contains, >=, <=, icontains, iexact, endswith, exact, <, >.
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
Supported comparison operators:
startswith, contains, >=, <=, icontains, iexact, endswith, exact, <, >.
parentnode
Actual location of the field:
devilry.apps.core.models.Subject
About the field:
Autogenerated identifier.
Type
Integer
Supported comparison operators:
startswith, contains, >=, <=, icontains, iexact, endswith, exact, <, >.
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
Supported comparison operators:
startswith, <=, >=, contains, icontains, iexact, endswith, exact, <, >.
parentnode__parentnode
Actual location of the field:
devilry.apps.core.models.Node
About the field:
Autogenerated identifier.
Type
Integer
Supported comparison operators:
startswith, <=, >=, contains, icontains, iexact, endswith, exact, <, >.
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
Supported comparison operators:
startswith, <=, >=, contains, icontains, iexact, endswith, exact, <, >.
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
Supported comparison operators:
startswith, contains, >=, <=, icontains, iexact, endswith, exact, <, >.
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)
Supported comparison operators:
startswith, contains, >=, <=, icontains, iexact, endswith, exact, <, >.

exact_number_of_results

If given, this must be a positive integer (including 0), which specifies the exact number of expected results. This enables searches that you know should fail if they do not get this exact number of results, such as filtering for a User by unique username instead of its numeric ID (where you should expect exactly one result).

orderby

List of fieldnames. Order the result by these fields. Fieldnames can be prefixed by '-' for descending ordering.

start

After query, filters and orderby have been executed, the result is limited to the values from start to start+limit. Start defalts to 0.

limit

Limit results to this number of items. Defaults to 50.

result_fieldgroups

A list of group names. Each group adds an additional set of fields to the results of the search. 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

Response

On success

Example

note that the is wrong in the example. The id is always unique. However, the example is generated from a non-varying dataset.

200 OK

{
    total: 20,
    items: [
        { 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" },
        { 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" },
        ...
    ]
}

Success response details

Responds with HTTP code 200 and a JSON encoded dict containing the list of results and the total number of items found before applying limit and start. Each result in the list is a JSON object where the key is a fieldname and the associated value is the value for that field. 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 error

On errors, we respond with one of the HTTP Error status codes.

Table Of Contents

Previous topic

GET /examiner/restfulsimplifiedperiod/id

Next topic

GET /examiner/restfulsimplifiedassignment/id

This Page

Navigation

© Copyright 2011, The Devilry Team. Created using Sphinx 1.0.7.