.. _administrator_restfulsimplifiedrelatedstudentkeyvalue_details_read:

=============================================================================
GET /administrator/restfulsimplifiedrelatedstudentkeyvalue/id
=============================================================================

Retrieve a related student key value.

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


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


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

.. code-block:: javascript

    GET /administrator/restfulsimplifiedrelatedstudentkeyvalue/id



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

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

The unique identifier of a related student key value. You will typically get
this id in response from a search.





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

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

Example
-------

.. code-block:: javascript

    200 OK

    {
        relatedstudent: 15,
        student_can_read: true,
        id: 15,
        application: "My example value",
        key: "My example value",
        value: "myvalue"
    }

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

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

    
        relatedstudent
            Actual location of the field:
                :class:`devilry.apps.core.models.relateduser.RelatedStudent`
            About the field:
                Autogenerated identifier.
            Type
                Integer
    
        student_can_read
            Actual location of the field:
                :class:`devilry.apps.core.models.relateduser.RelatedStudentKeyValue`
            About the field:
                Specifies if a student can read the value or not.
            Type
                Boolean
    
        id
            Actual location of the field:
                :class:`devilry.apps.core.models.relateduser.RelatedStudentKeyValue`
            About the field:
                Autogenerated identifier.
            Type
                Integer
    
        application
            Actual location of the field:
                :class:`devilry.apps.core.models.relateduser.RelatedStudentKeyValue`
            About the field:
                Application identifier. Max 300 chars.
            Type
                String
    
        key
            Actual location of the field:
                :class:`devilry.apps.core.models.relateduser.RelatedStudentKeyValue`
            About the field:
                Key. Max 300 chars.
            Type
                String
    
        value
            Actual location of the field:
                :class:`devilry.apps.core.models.relateduser.RelatedStudentKeyValue`
            About the field:
                Value.
            Type
                String
    





On error
########

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