.. _administrator_restfulsimplifiedperiodapplicationkeyvalue_details_read:

=============================================================================
GET /administrator/restfulsimplifiedperiodapplicationkeyvalue/id
=============================================================================

Retrieve a period application key value.

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


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


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

.. code-block:: javascript

    GET /administrator/restfulsimplifiedperiodapplicationkeyvalue/id



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

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

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





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

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

Example
-------

.. code-block:: javascript

    200 OK

    {
        period: 15,
        id: 15,
        application: "My example value",
        key: "My example value",
        value: "myvalue"
    }

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

As long as the period application 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:

    
        period
            Actual location of the field:
                :class:`devilry.apps.core.models.Period`
            About the field:
                Autogenerated identifier.
            Type
                Integer
    
        id
            Actual location of the field:
                :class:`devilry.apps.core.models.period.PeriodApplicationKeyValue`
            About the field:
                Autogenerated identifier.
            Type
                Integer
    
        application
            Actual location of the field:
                :class:`devilry.apps.core.models.period.PeriodApplicationKeyValue`
            About the field:
                Application identifier. Max 300 chars.
            Type
                String
    
        key
            Actual location of the field:
                :class:`devilry.apps.core.models.period.PeriodApplicationKeyValue`
            About the field:
                Key. Max 300 chars.
            Type
                String
    
        value
            Actual location of the field:
                :class:`devilry.apps.core.models.period.PeriodApplicationKeyValue`
            About the field:
                Value.
            Type
                String
    





On error
########

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