La création d'un événement sur cette route permet dans une même requête de:
- créer un événement
- définir son statut au sein de l'agenda
- lui associer des données personnalisées, définies au préalable dans le modèle de l'agenda
Important: Une authentification est nécessaire pour cette opération.
L'ajout d'un nouvel événement sur un agenda se fait par le biais d'une requête post à la route suivante:
/v2/agendas/{agendaUid}/events
Paramètres
Les paramètres suivants sont à placer dans le corps ( body ) de la requête.
- data: les données de l'événement. Voir les sections suivantes pour le détail.
À noter: Si le ou les événements qui seront créés ne seront pas multilingues et que vous souhaitez placer des textes au niveau des champs textuels (titre, description, keywords...), précisez la langue dans une clé "lang" en entête (header) de votre requête. Exemple: lang=fr
Contenu du champ 'data'
Les données nécessaires à la création d'un événement, son état au sein de l'agenda et ses données personnalisées doivent toutes être spécifiées dans le corps de requête sous la clé 'data'.
Les champs standards
Les champs standards sont détaillés dans une section dédiée
Les champs spécifiques à un agenda
Les champs spécifiant le statut de l'événement au sein de l'agenda sont
- state: entier - l'état de l'événement à l'ajout. Les valeurs possibles sont
- 0: événement non publié, à contrôler
- 1: événement non publié, controlé
- 2: événement publié (valeur par défaut)
- featured: booléen ( défaut: false ) - vrai quand l'événement doit apparaître en tête de liste ( en une )
Les champs additionnels
La structure de ces champs est détaillée dans la section configuration d'un agenda