Structure

Champs constituants un événement sur OpenAgenda

Résumé

Champ	Code	Description
Identifiant Unique	uid	Identifiant unique OpenAgenda de l’événement
Code URL	slug	Identifiant texte unique OpenAgenda de l’événement
Titre	title	Le titre de l'événement
Description courte	description	La description courte de l'événement
Description longue	longDescription	La description longue de l'événement
Conditions	conditions	Description libre des conditions de participation à l’événement
Mots clés	keywords	Liste de mots clés
Image	image	Illustration principale
Crédits de l’image	imageCredits	Crédits liés à l’illustration
Outils d’inscription	registration	Liste des moyens d’inscription : numéros de téléphones, email ou liens hypertextes
Accessibilité particulière	accessibility	Liste d'installations spécifiques disponibles à l'événement pour les handicaps donnés
Horaires	timings	Liste de plages horaires
Age du public ciblé	age	Créneau min/max d'âge des participants ciblés
Identifiant de lieu	locationUid	Identifiant unique OpenAgenda du lieu associé
Mode de participation	attendanceMode	Mode de participation à l’événement (physique vs en ligne)
Lien d’accès	onlineAccessLink	Lien hypertexte d'accès à un événement en ligne ou mixte
Lien enrichis	links	Liste de paires lien / codes enrichis
Fuseau horaire	timezone	Fuseau horaire de référence
État	status	État de l'événement (Reporté, Annulé, Complet...)
Statut	state	Statut de l'événement sur l'agenda lu (Publié, Prêt à publier, À modérer, Refusé)
Date de création	createdAt
Date de dernière mise à jour	updatedAt

Détail

Identifiant Unique

Identifiant unique OpenAgenda de l'événement

Caractéristiques

Code: uid
Type: entier
Assigné à la création, non éditable

Code URL

Identifiant utile pour construire une URL lisible dérivée du titre de l'événement.

Caractéristiques

Code: slug
Type: texte
Mis à jour sur modification du titre de l'événement

Titre

Le titre de l'événement

Caractéristiques

Code: title
Type: texte multilingue
Champ obligatoire ne pouvant excéder 140 caractères par langue
Equivalence schema.org: name

Exemple

{
    ...
    "title": {
        "fr": "Le Coin Vert de Stéphane",
        "en": "The Green Corner of Stéphane",
        "es": "El rincón verde de Esteban",
        "de": "Le Coin Vert de Stéphane",
        "it": "La Zona Verde di Stéphane"
    },
    ...
}

Description courte

La description courte de l'événement

Caractéristiques

Code: description
Type: texte multilingue
Champ obligatoire ne pouvant excéder 200 caractères par langue
Equivalence schema.org: disambiguatingDescription

Description longue

La description longue de l'événement

Caractéristiques

Code: longDescription
Type: texte multilingue markdown
Optionnel, ne peut excéder 10000 caractères par langue
Equivalence schema.org: description

Contenus enrichis

Certains liens insérés dans la description longue sont extraits lors de la création ou à la mise à jour et sont associés à des codes d'intégration enrichis mis à disposition dans le champ links de l'événement ainsi que dans la variante html de la description longue.

Les liens issus des services suivants sont concernés:

Allociné
Arte
Calameo
Dailymotion
Eventbrite
Flickr
Google Forms
INA
Instagram
PictoAccess
Prezi
Soundcloud
Twitch
Twitter
Vimeo
WeMap
Youtube

Exemple

Une description longue d'exposition:

{
    ...
    "longDescription": {
        "fr": "**Chaque samedi à 16h, La Piscine propose une visite guidée
        de l'exposition temporaire en cours**\n\nDu 15 décembre au 
        28 mars 2021 :\n\n### EUGÈNE DODEIGNE (1923-2015) : UNE RÉTROSPECTIVE\n\nPour
        renouer avec son public après le confinement, La Piscine fait le
        choix symbolique fort de présenter un grand sculpteur lié à la
        région. Figure essentielle de la sculpture française contemporaine, 
        à laquelle il a apporté une contribution très singulière reconnue dans le
        monde entier, Eugène Dodeigne est aussi l’une des figures de proue
        du Groupe de Roubaix.\n\nCette rétrospective dresse un portrait 
        renouvelé de l’artiste, beaucoup moins « monolithique » qu’on ne le
        pensait jusqu’ici, en reconsidérant son œuvre dans toute sa
        richesse. Aux côtés des pierres de Soignies – sa signature évidente
        –, seront présentés des plâtres, bois, bronzes, terres cuites,
        dessins, peintures et éléments de mobilier, embrassant en quelques
        200 œuvres – l’ensemble le plus important jamais rassemblé – près
        de soixante ans de création.\n\n
        [En savoir plus sur cette exposition](https://www...ositions/a-...)"
    },
    ...
}

Conditions

Description libre des conditions de participation à l’événement

Caractéristiques

Code: conditions
Type: texte multilingue
Optionnel, ne peut excéder 255 caractères par langue
Correspondance partielle schema.org isAccessibleForFree

Mots clés

Liste de mots clés

Caractéristiques

Code: keywords
Type: liste de textes multilingue
Optionnel, ne peut excéder 255 caractères par langue

{
    ...
    "keywords": {
        "fr": ["musique", "concert", "rock"]
    },
    ...
}

Image

Illustration principale

Caractéristiques

Code: image
Type: Fichier jpeg
Optionnel, ne peut excéder 20Mo au chargement

Création / Mise à jour

Lors de la création ou mise à jour d'un événement via l'API, une image peut-être passée de deux manières distinctes:

Un fichier, passé via un post multipart/form-data sous la clé image
Un url, dans ce cas en sous clé dans le champ image d'un post de type application/json

Les formats acceptés d'image sont les suivants: jpeg, bmp, webp, png

Exemple de contenu pour la clé image dans un post application/json:

{
    ...
    "image": {
        "url" : "https://i.pinimg.com/originals/d1/d9/ae/d1d9aec6e351baa115000b4b75e02b1b.jpg"
    },
    ...
}

Lecture

Les formats générés, ainsi que les éventuels crédits associés sont fournis au niveau du champ. Le champ image contient les données suivantes:

filename: le nom du fichier
base: le chemin où se trouve l'image
size: les dimensions de l'image en pixels (width, height)
variants: les variantes disponibles de l'image

Exemple du détail fourni pour un événement:

{
    ...
    "image": {
        "filename": "9f3c5316f367409dac9af3527233feab.base.image.jpg",
        "size": {
            "width": 700,
            "height": 394
        },
        "variants": [
            {
                "filename": "9f3c5316f367409dac9af3527233feab.full.image.jpg",
                "size": {
                    "width": 960,
                    "height": 540
                },
                "type": "full"
            },
            {
                "filename": "9f3c5316f367409dac9af3527233feab.thumb.image.jpg",
                "size": {
                    "width": 200,
                    "height": 200
                },
                "type": "thumbnail"
            }
        ],
        "base": "https://cibul.s3.amazonaws.com/"
    }
    ...
}

Crédits de l’image

Crédits liés à l’illustration

Caractéristiques

Code: imageCredits
Type: texte
Optionnel, ne peut excéder 255 caractères

Outils d’inscription

Liste des moyens d’inscription : numéros de téléphones, email ou liens hypertextes

Caractéristiques

Code: registration
Type: liste de valeurs de type téléphone, email ou lien hypertexte
Optionnel, ne peut excéder 2000 caractères au total

Exemple

{
    ...
    "registration": [
        "https://formationcontinue.univ-rennes1.fr/cafeinfo",
        "formcont@univ-rennes1.fr",
        "0203040506"
    ],
    ...
}

Accessibilité particulière

Liste d'installations spécifiques disponibles à l'événement pour les handicaps donnés

Caractéristiques

Code: accessibility
Type: Liste de codes d'accessibilité
Optionnel

Codes d'accessibilité

hi (Hearing impairment): Handicap auditif
vi (Visual impairment): Handicap visuel
pi (Psychic impairment): Handicap psychique
mi (Motor impairment): Handicap moteur
ii (Intellectual impairment): Handicap intellectuel

Pour en savoir plus sur les handicaps, rendez vous ici

Exemple

Un événement ayant une installation prévue pour les personnes malvoyantes:

{
    ...
    "accessibility": {
        "hi":false,
        "ii":false,
        "vi":true,
        "mi":false,
        "pi":false
    },
    ...
}

Horaires

Liste de plages horaires

Caractéristiques

Code: timings
Type: Liste de paires de valeurs date: begin et end
Obligatoire. Ne peut excéder les 800 horaires. Une plage horaire ne peut excéder 24 heures de durée

Exemple

Une pièce de théatre qui a lieu tous les jours sur une semaine de 17h à 19h:

[
    {
        "begin": "2021-02-25T17:00:00+0200",
        "end": "2021-02-25T19:00:00+0200"
    },
    {
        "begin": "2021-02-26T17:00:00+0200",
        "end": "2021-02-26T19:00:00+0200"
    },
    {
        "begin": "2021-02-27T17:00:00+0200",
        "end": "2021-02-27T19:00:00+0200"
    },
    {
        "begin": "2021-02-28T17:00:00+0200",
        "end": "2021-02-28T19:00:00+0200"
    },
    {
        "begin": "2021-02-29T17:00:00+0200",
        "end": "2021-02-29T19:00:00+0200"
    }
]

Age du public ciblé

Créneau min/max d'âge des participants ciblés

Caractéristiques

Code: age
Type: Paire de valeurs en années: min et max
Optionnel. max ne peut excéder 120 ans
Equivalence schema.org: typicalAgeRange

Exemple

Valeur du champ age pour un événement pour les enfants de 6 ans ou moins:

{
    ...
    "age": {
        "min":0,
        "max":6
    },
    ...
}

Identifiant de lieu

Identifiant unique OpenAgenda du lieu associé

Caractéristiques

Code: locationUid
Type: Entier
Obligatoire pour les événements à mode de participation mixtes et hors ligne

Mode de participation

Mode de participation à l’événement (physique vs en ligne)

Caractéristiques

Code: attendanceMode
Type: Code entier
Optionnel (hors-ligne par défaut)

Codes de modes de participation

1 (offline): Participation physique au lieu où se déroule l'événement
2 (online): Participation en ligne via un lien
3 (mixed): Participation mixte

Lien d’accès

Lien hypertexte d'accès à un événement en ligne ou mixte

Caractéristiques

Code: onlineAccessLink
Type: Lien hypertexte
Obligatoire si le mode de participation est en ligne ou mixte

Liens enrichis

Liste de paires de valeurs lien / code enrichi

Caractéristiques

Code: links
Type: Liste de paires de valeurs lien hypertexte / objet détaillant le code html d'intégration
Dérive des liens saisis dans le champ de description longue (longDescription)

Exemple

[
    {
        "link": "https://fr.calameo.com/read/0000531370e47329f0819",
        "data": {
            "url": "https://www.calameo.com/read/0000531370e47329f0819",
            "type": "rich",
            "version": "1.0",
            "title": "Activités Petite Enfance - Vacances d'Hiver / 0-6 ans",
            "author": "Ville de Roubaix",
            "author_url": "https://www.calameo.com/accounts/53137",
            "provider_name": "calameo.com",
            "description": "Activités 0-6 ans Petite Enfance vacances d’Hiver...",
            "thumbnail_url": "https://p.calameoassets.com/210205112752-fc92911ad9.../p1.jpg",
            "thumbnail_width": 1125,
            "thumbnail_height": 1596,
            "html": "<div style=\"left: 0; width: 100%;....</div>",
            "cache_age": 86400
        }
    }
]

Fuseau horaire

Nom du fuseau horaire de référence

Caractéristiques

Code: timezone
Type: Texte. Nom du fuseau selon la base de données TZ
Ce champ est automatiquement défini selon le lieu associé à l'événement

État

L'état d'un événement informe l'utilisateur de sa disponibilité. Lorsque la valeur définie n'est pas la valeur par défaut (l'événement est programmé), l'information devient aussi essentielle que le titre. Les états possibles:

Programmé (1): État par défaut. L'événement est programmé aux horaires indiqués
Reprogrammé (2): Les horaires ont changé
Déplacé en ligne (3): L'événement qui se déroulait à un lieu physique n'est désormais accessible qu'en ligne
Reporté (4): L'événement ne se déroule plus aux horaires indiqués, les nouveaux horaires ne sont pas encore disponibles
Complet (5): L'événement n'est plus accessible aux nouveaux participants
Annulé (6): L'événement n'est plus programmé aux horaires indiqués et n'est pas reporté.

Caractéristiques

Code: status
Type: entier

Statut

Indique l'état de l'événement dans le cadre du circuit de modération d'un agenda. L'événement n'est publiquement accessible que s'il a un statut à "Publié". Les événements ayant un autre statut ne sont visibles que par les utilisateurs membres de l'agenda et ayant un rôle de modérateur ou d'administrateur. Les statuts possibles sont:

Publié (2): L'événement est affiché sur les flux et la page de l'agenda
Prêt à publier (1): Signifie que l'événement a été vu et traité par un membre modérateur ou administrateur. L'événement n'est visible que des membres autorisés.
À modérer (0): Signifie que l'événement n'a pas encore été traité par un membre modérateur ou administrateur de l'agenda. L'événement n'est visible que des membres autorisés.
Refusé (-1): L'événement a été traité et a été refusé par un membre modérateur ou administrateur de l'agenda. En principe, un événement avec ce statut ne sera jamais publié sur l'agenda.

Caractéristiques

Code: state
Type: entier

Date de création

Instant de la création de l'événement

Caractéristiques

Code: createdAt
Type: Date
Ce champ est automatiquement défini au moment de la création de l'événement

Date de dernière mise à jour

Instant de la dernière mise à jour de l'événement

Caractéristiques

Code: updatedAt
Type: Date
Ce champ est automatiquement remis à jour à chaque modification de l'événement