{% extends "master.html" %} {% from "_formhelpers.html" import render_field %} {% block title %} API {{ title }} {% endblock %} {% set title_extent = 'API' %} {% block content %}

API documentation

Fedocal provides a small API to retrieve information from the database in JSON.

Retrieve meetings in a time frame

In order to retrieve all the meetings within a given time frame you will need to query

{{ url_for('api_date', calendar_name='calendar', start_date='start_date', end_date='end_date') }}

The arguments are:

The last two arguments (start_date & end_date) are actually optionnals meaning that you may call

{{ url_for('api_date_default', calendar_name='calendar_name') }}

This will by default return you the coming six months.

Retrieve meeting in a time frame in a region

In order to retrieve all the meetings within a given time frame and for a specific region, you will need to query

{{ url_for('api_place', region='region', calendar_name='calendar_name', start_date='start_date', end_date='end_date') }}

The arguments are:

The last two arguments (start_date &s; end_date) are actually optionnals meaning that you may call

{{ url_for('api_place_default', region='region', calendar_name='calendar_name') }}

This will by default return you the coming six months.

Note, not all calendars have regional settings allowed for their meetings, so you might not be able to retrieve meetings based on this criteria.

{% endblock %}