API documentation for Session Service
=====================================

General information
-------------------

Bus name: ``org.ArcticaProject.RWA``

Object name: ``/RWA``

Methods
-------

start
^^^^^
Start a new remote session and register it in RWA

**Arguments:** none

**Return type:** string (JSON)

**Structure of returned JSON:**

::

    {"id": <pid>, "url": "<url>", "pin": <pin>}


status
^^^^^^
Return the status of a session

.. note::

    This uses the last status version got by the update service in the background.

**Arguments:** pid/id (integer)

**Return type:** string (JSON)


**Structure of returned JSON:**

::

    {"id": <pid>, "status": <status>}

**Possible status options:**

- ``running``: The session is running and ready for connecting.
- ``joined``: The session is running and a the remote connected to the session.

refresh_status
^^^^^^^^^^^^^^
Same as ``status``, but updates status from Django before returning it here.

stop
^^^^
Stop a remote session

**Arguments:** pid/id (integer)

**Return type:** none