.. _administrator_restfulsimplifiedperiodapplicationkeyvalue_details_update:

=============================================================================
PUT /administrator/restfulsimplifiedperiodapplicationkeyvalue/id
=============================================================================

Update a period application key value.

The underlying data model where the item is updated 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.update`.



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


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

.. code-block:: javascript

    PUT /administrator/restfulsimplifiedperiodapplicationkeyvalue/id

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


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

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

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


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.



application
--------------------------------------------------

Actual location of the field:
    :class:`devilry.apps.core.models.period.PeriodApplicationKeyValue`
About the field:
    Application identifier. Max 300 chars.
Type
    String


value
--------------------------------------------------

Actual location of the field:
    :class:`devilry.apps.core.models.period.PeriodApplicationKeyValue`
About the field:
    Value.
Type
    String


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

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


key
--------------------------------------------------

Actual location of the field:
    :class:`devilry.apps.core.models.period.PeriodApplicationKeyValue`
About the field:
    Key. Max 300 chars.
Type
    String




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

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

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

.. code-block:: javascript

    200 OK

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


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

As long as the period application key value is updated without an error, the
response is *HTTP 201* with the requested data in the body.  The result always
contains the data you sent in to the update method, 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`.