.. _administrator_restfulsimplifiedexaminer_details_read:

=============================================================================
GET /administrator/restfulsimplifiedexaminer/id
=============================================================================

Retrieve a examiner.

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


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


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

.. code-block:: javascript

    GET /administrator/restfulsimplifiedexaminer/id



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

.. code-block:: javascript

    GET /administrator/restfulsimplifiedexaminer/id

    {
        result_fieldgroups: ["userdetails"]
    }


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

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

The unique identifier of a examiner. 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:

    userdetails
        *Expands to the following fields:*
        
            user__username
                Actual location of the field:
                    :class:`django.contrib.auth.models.User`
                About the field:
                    Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters
                Type
                    String
        
            user__email
                Actual location of the field:
                    :class:`django.contrib.auth.models.User`
                About the field:
                    
                Type
                    String
        
            user__devilryuserprofile__full_name
                Actual location of the field:
                    :class:`devilry.apps.core.models.DevilryUserProfile`
                About the field:
                    List of many values.
                Type
                    List of strings
        





**************
Response
**************

On success
##########

Example
-------

.. code-block:: javascript

    200 OK

    {
        user: 15,
        id: 15,
        assignmentgroup: 15
    }

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

As long as the examiner is deleted without an error, the
response is *HTTP 200* with the requested data in the body.
The result always contains the following fields:

    
        user
            Actual location of the field:
                :class:`django.contrib.auth.models.User`
            About the field:
                Autogenerated identifier.
            Type
                Integer
    
        id
            Actual location of the field:
                :class:`devilry.apps.core.models.Examiner`
            About the field:
                Autogenerated identifier.
            Type
                Integer
    
        assignmentgroup
            Actual location of the field:
                :class:`devilry.apps.core.models.AssignmentGroup`
            About the field:
                Autogenerated identifier.
            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`.