.. index:: User, UserReview

.. _user_review:

User review
===========

The user review is an individual review by a person. All the reviews together will result in an average score.

.. _user-review-fields:

Fields
------

.. apifields::
    .. apifield::
        :name: name
        :type: string
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The name of the reviewer
    .. apifield::
        :name: place
        :type: string
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The place of the reviewer
    .. apifield::
        :name: date
        :type: date
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The date of the review
    .. apifield::
        :name: reason
        :type: string
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The reason why the review was written
    .. apifield::
        :name: content
        :type: string
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The actual textual content of the review. This generally contains a detailed description of the experience of the reviewer.
    .. apifield::
        :name: overallScore
        :type: number (float)
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The overall score given by the reviewer
    .. apifield::
        :name: subScores
        :type: array(object)
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The subscores for the various parts on which a user can get individual scores.
    .. apifield::
        :name: subScores.description
        :type: string
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The description of the subscore
    .. apifield::
        :name: subScores.score
        :type: number (float)
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The score of an individual item on which the user get rated


Examples
--------

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