Catégories d'événements

Les événements issus de l'API Amienscope sont classés dans différentes catégories.

Afin d'obtenir des listings d'événements via la liste des événements d'une catégorie, il est nécessaire de lister toutes les catégories afin d'obtenir leurs identifiants uniques correspondants.

Les catégories utilisées dans l'API Amienscope ne sont pas fixes. La collectivité ayant la possibilité d'ajouter, modifier et supprimer des catégories d'événements, il est préférable de faire cette requête de récupération des catégories avant d'effectuer requête de listing d'événements.

GET https://api.amienscope.fr/get/categories

En cas d'erreur, l'API renvoie un objet JSON spécifique (cf. Erreurs) :

{
	"error": { "err_num":"AEx0XX", "err_str":"Error Message" }
}

En cas de succès, l'API renvoie un objet JSON (de type tableau) contenant toutes les catégories utilisées dans l'API :

[
	{
		"id":"4",
		"name":"Concert",
		"icon_filename":"ic_play_circle_filled_48px.svg",
		"icon_distant_url":"http:\/\/api.<domain.com>\/static\/im\/layout\/icons\/material-icons-svg\/ic_play_circle_filled_48px.svg",
		"event_count":"16"
	},
	{
		"id":"3",
		"name":"Th\u00e9\u00e2tre",
		"icon_filename":"ic_accessibility_48px.svg",
		"icon_distant_url":"http:\/\/api.<domain.com>\/static\/im\/layout\/icons\/material-icons-svg\/ic_accessibility_48px.svg",
		"event_count":"6"
	},
	{
		"id":"7",
		"name":"Danse",
		"icon_filename":"ic_queue_music_48px.svg",
		"icon_distant_url":"http:\/\/api.<domain.com>\/static\/im\/layout\/icons\/material-icons-svg\/ic_queue_music_48px.svg",
		"event_count":"4"
	},
	{
		"id":"11",
		"name":"F\u00eate et Festival",
		"icon_filename":"ic_local_play_48px.svg",
		"icon_distant_url":"http:\/\/api.<domain.com>\/static\/im\/layout\/icons\/material-icons-svg\/ic_local_play_48px.svg",
		"event_count":"3"
	}
	...
]

Champ	Type	Description
`id`	int	Identifiant unique de la catégorie
`name`	str	Nom/Libellé de la catégorie
`icon_filename`	str	Chemin relatif de l'icône associée (format SVG)
`icon_distant_url`	str	Chemin absolu (URL) de l'icône associée (format SVG)
`event_count`	int	Nombre d'événements actuellement présents dans cette catégorie

L'identifiant unique d'une catégorie peut à présent être utilisé pour effectuer une requête de listing d'événements sur une catégorie donnée.

Vous pouvez tester si une catégorie, caractérisée par son identifiant unique, existe sur le système et/ou est visible (elle ne sera pas visible si elle a été désactivée par l'administrateur).

GET https://api.amienscope.fr/get/category_visible/<id>

En cas d'erreur, l'API renvoie un objet JSON spécifique (cf. Erreurs) :

{
	"error": { "err_num":"AEx0XX", "err_str":"Error Message" }
}

En cas de succès, l'API renvoie un objet JSON (de type tableau) contenant deux champs booléens :

{
	"is_visible":"true",
	"exists":"true"
}

Les champs retournés ne sont pas booléens au sens strict, mais contiennent les chaînes de caractères "true" ou "false".

Pour vous assurer qu'une catégorie existe et doit être affichée, il convient donc de vérifier qu'elle existe sur le système (exists = "true") et qu'elle est bien active (is_visible = "true").

/get/organisers: Organisateurs d'événements connus de l'API
/get/events/<id>: Événements présents dans une catégorie donnée
/get/from_organiser/<id>: Événements d'un organisateur donné
/get/audiences: Liste des publics visés utilisés par les événements
/get/event/<id>: Détail des informations complètes d'un événement spécifique
/get/updates/<time>: Événements mis à jour ou modifiés depuis une date donnée
/get/highlights: Événements mis en avant par la collectivité (ou « À la Une »)
/get/recent: Événements ajoutés le plus récemment
/get/next: prochains événements à venir, sans distinction de catégorie
/search/<criteria>: Recherche d'événements par critères spécifiques
/get/popular: Événements les plus populaires
/get/accessibilities: Liste des formes d'accessibilité disponibles
/get/from_accessibility: Liste d'événements correspondant à une forme d'accessibilité

Requête sur l'API

Valeurs de retour

Détail des champs retournés

Existence et visibilité d'une catégorie

Requête sur l'API

Valeurs de retour

Voir aussi