.. index:: User, UserReviewSettings, ReviewSettings

.. _user_reviews_settings:

User review Settings
====================

The user review entity contains information regarding reviews on this user. It is basically configuration on how to fetch reviews from an
external provider, and currently only supported for dealers. The settings here are only shown on the website when the user has bought the
feature *Klantscore* . Information on buying features can be found at :ref:`buy-feature <buy_user_feature>`.


.. _user-review-fields:

Fields
------

.. apifields::
    .. apifield::
        :name: reviewsPlatform
        :type: string
        :constraints: max. 150 chars, ``tevreden`` or ``klantenvertellen``
        :required: true
        :updateable: true
        :writable: true
        :description: The platform used for external reviews. This should either be ``tevreden`` or ``klantenvertellen``
    .. apifield::
        :name: reviewsUser
        :type: string
        :constraints: max. 100 chars
        :required: true
        :updateable: true
        :writable: true
        :description: The user id of the dealer on the dealer reviews site.

Reference
---------

.. endpoint:: GET /v1/users/{userId}/reviews-settings

Get user review settings

.. endpoint:: PUT /v1/users/{userId}/reviews-settings

Update a user's review settings

.. endpoint:: PATCH /v1/users/{userId}/reviews-settings

Do a partial update of a user's review settings


Errors
------

.. errors::
    .. error::
        :http: 400
        :code: validation-failure

        Validation of the user-review settings failed.

Field errors
------------

.. fielderrors::
    .. error::
        :field: <field name>
        :code: input-invalid
        :description: The value for this field is invalid.
    .. error::
        :field: <field name>
        :code: input-too-long
        :description: The length of the supplied value exceeds the maximum allowed length for this field
        :value: the maximum allowed length
    .. error::
        :field: <field name>
        :code: missing-required-field
        :description: A required field is missing or empty (while that is not allowed).


Examples
--------

.. include:: examples/get-user-reviews-example.rst