.. _administrator_restfulsimplifiedrelatedstudent_details_create:

=============================================================================
POST /administrator/restfulsimplifiedrelatedstudent/
=============================================================================

Create a related student.

The underlying data model where the item is created is defined in
:class:`devilry.apps.core.models.relateduser.RelatedStudent`.
The :ref:`simplified` that the server forwards this request to is
:meth:`devilry.apps.administrator.simplified.simplifiedrelatedstudent.SimplifiedRelatedStudent.create`.


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


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

.. code-block:: javascript

    POST /administrator/restfulsimplifiedrelatedstudent/

    {
        candidate_id: "My example value",
        period: 15,
        user: 15
    }


Required request parameters
###########################

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



candidate_id
--------------------------------------------------

Actual location of the field:
    :class:`devilry.apps.core.models.relateduser.RelatedStudent`
About the field:
    If a candidate has the same Candidate ID for all or many assignments in a semester, this field can be set to simplify setting candidate IDs on each assignment.
Type
    String


period
--------------------------------------------------

Actual location of the field:
    :class:`devilry.apps.core.models.Period`
About the field:
    Autogenerated identifier.
Type
    Integer


user
--------------------------------------------------

Actual location of the field:
    :class:`django.contrib.auth.models.User`
About the field:
    Autogenerated identifier.
Type
    Integer




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

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

Example
----------------

.. code-block:: javascript

    201 CREATED

    {
        candidate_id: "My example value",
        period: 15,
        user: 15,
        id: 15
    }


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

As long as the related student is created without an error, the
response is *HTTP 201* with the requested data in the body. The result always
contains the request data with the *id* field added, however some values may
have been changed due to logic performed on the server before saving.



On error
########

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