Orga API
========

The Orga API provides programmatic access to the data of an event.
In the future it may also allow directly creating, changing and deleting entities
like courses and registrations.

In order to use this API a secret Token must be created and provided in the
HTTP-Header of every request under the key ``X-CdEDB-API-token``.

Example::

    requests.get(
        f"https://db.cde-ev.de/db/event/event/{event_id}/droid/partial",
        headers={"X-CdEDB-API-Token": secret},
    )

.. warning:: The Orga API is currently in beta. Specifics may still change and
    only read-access is currently available.

Available Endpoints
-------------------

All orga droid endpoints are located in the same URL-schema:

``/event/event/<event_id>/droid/<endpoint>``.

Partial Export
++++++++++++++

An orga droid may fetch a partial export of its event under ``droid/partial``.
This is a read-only operation.

The partial export is a JSON file of the same format one may download via the
regular frontend.