.. index:: User, LogoImage

.. _logo_image:

Logo image
==============

Image used as the logo of a user's profile page

Currently the only way to set the logo image is by issuing a POST against the logo-image resource with a
post body that contains a URL. A placeholder image will be created for the uploaded image and the real image is
downloaded in the background. An image will have its status attribute set to downloading until
downloading completes. Clients interested in knowing when the image download has completed should poll the logo-image
resource and wait until the status attribute changes.

See :ref:`image <image>` to find out which fields are returned when issuing a GET against this resource.

Reference
---------

.. endpoint:: GET /v1/users/{userId}/profile/logo-image

Returns the logo image of a user profile. Returns statuscode 404 if no logo image is available.

.. endpoint:: POST /v1/users/{userId}/profile/logo-image

Set the logo image of a user profile.

.. endpoint:: DELETE /v1/users/{userId}/profile/logo-image

Remove the logo image of a user profile.

Errors
------

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

        Validation of the image failed
        There should be more information in the field errors

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

.. fielderrors::
    .. error::
        :field: <field name>
        :code: field-missing
        :description: The value for this field is missing.

Examples
--------

.. include:: examples/get-logo-image-example.rst

.. include:: examples/async-set-logo-image-example.rst

.. include:: examples/delete-logo-image-example.rst