.. _examiner_restfulsimplifiedassignment_details_read:

=============================================================================
GET /examiner/restfulsimplifiedassignment/id
=============================================================================

Retrieve a Assignment.

The underlying data model where the item is retrieved from is defined in
:class:`devilry.apps.core.models.Assignment`.
The :ref:`simplified` that the server forwards this request to is
:meth:`devilry.apps.examiner.simplified.SimplifiedAssignment.read`.


********
Request
********


Example
################

.. code-block:: javascript

    GET /examiner/restfulsimplifiedassignment/id



Another example, this one uses the optional *result_fieldgroups* parameter.

.. code-block:: javascript

    GET /examiner/restfulsimplifiedassignment/id

    {
        result_fieldgroups: ["period", "subject"]
    }


Required request parameters encoded in the URL
##############################################

id
--------------

The unique identifier of a Assignment. You will typically get
this id in response from a search.



Optional request parameters
###########################

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

result_fieldgroups
------------------
A list of group names. Each group adds an additional set of fields to the
resulting data. The following group names are available:

    period
        *Expands to the following fields:*
        
            parentnode__short_name
                Actual location of the field:
                    :class:`devilry.apps.core.models.Period`
                About the field:
                    Max 20 characters. Only numbers, lowercase characters, '_' and '-'. 
                Type
                    String
        
            parentnode__long_name
                Actual location of the field:
                    :class:`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__start_time
                Actual location of the field:
                    :class:`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)
        
            parentnode__end_time
                Actual location of the field:
                    :class:`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)
        
            parentnode__parentnode
                Actual location of the field:
                    :class:`devilry.apps.core.models.Subject`
                About the field:
                    Autogenerated identifier.
                Type
                    Integer
        

    subject
        *Expands to the following fields:*
        
            parentnode__parentnode__short_name
                Actual location of the field:
                    :class:`devilry.apps.core.models.Subject`
                About the field:
                    Max 20 characters. Only numbers, lowercase characters, '_' and '-'. 
                Type
                    String
        
            parentnode__parentnode__long_name
                Actual location of the field:
                    :class:`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
-------

.. code-block:: javascript

    200 OK

    {
        id: 15,
        parentnode: 15,
        short_name: "my_example001_value",
        long_name: "My example value",
        publishing_time: "2010-02-22 22:32:10",
        delivery_types: 20,
        anonymous: true,
        scale_points_percent: 20
    }

Success response details
------------------------

As long as the Assignment 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:
                :class:`devilry.apps.core.models.Assignment`
            About the field:
                Autogenerated identifier.
            Type
                Integer
    
        parentnode
            Actual location of the field:
                :class:`devilry.apps.core.models.Period`
            About the field:
                Autogenerated identifier.
            Type
                Integer
    
        short_name
            Actual location of the field:
                :class:`devilry.apps.core.models.Assignment`
            About the field:
                Max 20 characters. Only numbers, lowercase characters, '_' and '-'. 
            Type
                String
    
        long_name
            Actual location of the field:
                :class:`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
    
        publishing_time
            Actual location of the field:
                :class:`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)
    
        delivery_types
            Actual location of the field:
                :class:`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
    
        anonymous
            Actual location of the field:
                :class:`devilry.apps.core.models.Assignment`
            About the field:
                Specifies if this assignment is anonymous.
            Type
                Boolean
    
        scale_points_percent
            Actual location of the field:
                :class:`devilry.apps.core.models.Assignment`
            About the field:
                Percent to scale points on this assignment by for period overviews. The default is 100, which means no change to the points.
            Type
                Integer
    


However, there may be more fields if specified with the ``result_fieldgroups``
request parameter.




On error
########

On errors, we respond with one of the :ref:`restful_api_error_statuscodes`.