Space types
===========

This section provides the specifications related to all supported space types that comply to the communication models

Definitions
-----------

:doc:`Common definitions <../common/common_definitions>`

:doc:`Common definitions <../common/object_model_definitions>`

.. include:: ../common/spaces_definitions.rst

Web API (Pull Model)
''''''''''''''''''''

- The digital twin information provider must expose the **spaces** endpoint to get the the list of available spaces and their specifications

.. code-block::

    GET https://{Digital Twin Information Provider URL}/fds/v2/spaces

- The device information provider must expose the **statuses** endpoint to get the latest status for one or multiple devices

.. code-block::

    GET https://{Device Information Provider URL}/fds/v2/statuses

- The device information provider must expose the **diagnostics** endpoint to get the diagnostic for one or multiple devices

.. code-block::

    GET https://{Device Information Provider URL}/fds/v2/diagnostics

.. note::

    The **statistics** endpoint to expose the statistics information is not being defined for dispensers in FDS Version 2

    A call to:
    
    .. code-block::

        GET https://{Device Information Provider URL}/fds/v2/statistics

    must return an error object

    .. code-block:: json

        {
            "status": 204,
            "message": "not_implemented"
        }

- The device information provider must expose the **POST** request on the **tag** endpoint to let a client application create a new tag

.. code-block::

    POST https://{Entity Information Provider URL}/fds/v2/tag

- The device information provider must expose the **GET** request on the **tag** endpoint to provide the content of a tag

.. code-block::

  GET https://{Entity Information Provider URL}/fds/v2/tag

- The device information provider must expose the **DELETE** request on the **tag** endpoint

.. code-block::

    DELETE https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>

- The device information provider must expose the **PUT** request on the **tag/<tag_id>/entities** endpoint

.. code-block::

    PUT https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>/entities

- The device information provider must expose the **DELETE** request on the **tag/<tag_id>/entities** endpoint

.. code-block::

    DELETE https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>/entities

Publish/Subscribe (Push model)
''''''''''''''''''''''''''''''

Events
""""""

- The device information provider must publish the following alerts and notifications

+--------------------------------+---------------------------------------+------------------+----------------------------------------+
| Message code                   | Description                           | Message category | Message code specific object           |
+================================+=======================================+==================+========================================+
| out_of_order                   | The device is out of order            | alert            |  **out_of_order_details**  property    |
|                                | and needs service intervention        |                  |  - array of information provider codes |
+--------------------------------+---------------------------------------+------------------+----------------------------------------+
| offline                        | The device is not communicating       | notification     |  **last_contact** property             |
+--------------------------------+---------------------------------------+------------------+----------------------------------------+


Publish status information
""""""""""""""""""""""""""

The following data must be published by the information provider

.. code-block::

  fds/v2/<subscriber_id>/<tag_id>/bin/<device_id>/status/filling_level


- The payload must be:

  - The **filling_level** object

Publish predictive and prognostic information
"""""""""""""""""""""""""""""""""""""""""""""

The following data must be published by the information provider

.. code-block::

  fds/v2/<subscriber_id>/<tag_id>/bin/<device_id>/diagnostics/expected_next_service

- The payload must be:
  
  - The **expected_next_service** property

.. toctree::
    :glob:
 
    types/*