[POST] /v2/agendas/{agendaUID}/events
  • agendaUID est l'identifiant de l'agenda où l'événement doit être créé
  • Une authentification est nécessaire. Voir ici.
  • Un paramètre lang peut être précisé en entête (lang:fr) pour simplifier le formatage d'événements monolingues.
  • Les données définissant l'événement doivent être placées sous une clé `data` en corps de requête.

La requête permet de créer un événement, définir son statut au sein de l'agenda au moment de la création et de lui associer des données spécifiques aux champs additionnels définis dans le schéma de l'agenda. Voir ici.

L'identifiant de l'événement est fourni en réponse une fois celui-ci créé

Création par identifiants externes

Il est possible de créer des événements via la route suivante. Cette route est particulièrement utile pour synchroniser une source de donnée disposant de ses propres identifiants d'événements:

[PUT] /v2/agendas/{agendaUID}/events/ext/{extKey}/{extID}
  • `extKey` est alors le nom de l'identifiant, `extID` sa valeur
  • Si l'événement existe déjà, il sera mis à jour
  • Un événement peut être associé à plusieurs identifiants externes
  • Un événement associé à un ou plusieurs identifiants externes garde un identifiant OpenAgenda unique (UID).

Exemple:

/v2/agendas/78891697/events/ext/apidae/fdq3f-fd21s-uefz

Corps de requête

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 de statut dans l'agenda

Les champs spécifiant le statut de l'événement au sein de l'agenda sont:

state

Un entier: le statut de l'événement à l'ajout. Les valeurs possibles sont:

  • 0: événement non publié, à contrôler
  • 1: événement non publié, contrôlé
  • 2: événement publié (valeur par défaut)

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