Cette route vous permet de récupérer des informations relatives à la configuration d'un agenda.

https://api.openagenda.com/v2/agendas/{agendaUid}?key={key}

Paramètres

  • agendaUid: l'uid de l'agenda, visible dans la barre latérale droite de l'agenda.
  • key: Votre clé api, disponible dans les paramètres de votre compte utilisateur. Alternativement, un token d'accès peut être utilisé lorsqu'il est en main.

La configuration des champs d'un formulaire est disponible à cette route, sous la clé schema.fields

Les champs d'un formulaire

Les champs du formulaire événement de l'agenda sont listés sous la clé schema.fields. Chaque champ est définit par les clés suivantes:

  • field: le nom du champ
  • fieldType: le type du champ
  • label, info, placeholder, sub: Des valeurs de labels utilisés pour la mise en page du formulaire
  • optional: le caractère optionnel du champ. Si celui-ci est 'false', le champ doit être informé pour toute création ou mise à jour de l'événement.
  • options: liste des valeurs possibles pour les champs de type radio, checkbox ou select. Pour les création/mise à jour d'événement, c'est la sous-clé id de l'option à préciser qui doit être spécifiée dans le corps de requête en face du nom du champ.
  • schemaType: Le type de schéma d'où provient le champ (event, agenda ou network)

Exemple de champ

{
  ...
  "schema": {
    "fields": [
      ...,
      {
        "field": "organisateur",
        "label": {
          "fr": "Organisateur"
        },
        "optional": true,
        "fieldType": "checkbox",
        "options": [
          {
            "id": 31,
            "value": "collectivite",
            "label": {
              "fr": "Collectivité"
            }
          },
          {
            "id": 32,
            "value": "association",
            "label": {
              "fr": "Association"
            }
          }
        ]
      }
    ]
  }
  ...
}