Liste d'événements d'une catégorie

Une fois que vous avez l'identifiant unique d'une catégorie donnée (à l'aide de la réquête de récupération des catégories), il vous est possible de demander la liste des événements d'une catégorie donnée.

Nous verrons plus bas dans cette page qu'il est également possible de demander des listes paginées à l'aide de paramètres supplémentaires passés à l'URL.

GET https://api.amienscope.fr/get/events/<category_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 les événements de cette catégorie :

[
	{
		"id":"2",
		"add_dt":"1440772235",
		"lastmod_dt":"1440779865",
		"highlighted":"1",
		"favorite_count":"142",
		"visit_count":"2560",
		"event_revision_add_dt":"1440772235",
		"event_title":"Spectacle Alexandre Astier",
		"event_description":"<p>Alexandre Astier en tourn\u00e9e dans \u00ab <strong>l'Exo Conf\u00e9rence<\/strong> : R\u00e9glons la question de la vie extra-terrestre \u00bb.<\/p>",
		"event_url_info":"http:\/\/www.zenith-amiens.fr",
		"event_status_label":"Publi\u00e9",
		"event_status_id":"2",
		"event_status_visible":"1",
		"categories":[
			{
				"category_id":"4",
				"category_name":"Concert",
				"icon_filename":"ic_play_circle_filled_48px.svg",
				"icon_distant_url":"http:\/\/api.<api_domain>\/static\/im\/layout\/icons\/material-icons-svg\/ic_play_circle_filled_48px.svg"
			},
			{
				"category_id":"6",
				"category_name":"Spectacle",
				"icon_filename":"ic_accessibility_48px.svg",
				"icon_distant_url":"http:\/\/api.<api_domain>\/static\/im\/layout\/icons\/material-icons-svg\/ic_accessibility_48px.svg"
			}
		],
		"address_location":"Z\u00e9nith Amiens M\u00e9tropole",
		"address_number":"",
		"address_street_addr":"Avenue de l'Hippodrome",
		"address_addr_info":"",
		"address_latitude":"49.895869",
		"address_longitude":"2.268285",
		"city_name":"Amiens",
		"city_uri":"amiens",
		"city_postal_code":"80000",
		"city_latitude":"49.900002",
		"city_longitude":"2.300000",
		"state_code":"80",
		"state_name":"Somme",
		"state_uri":"somme",
		"audience_id":"1",
		"audience_label":"Tout public",
		"picture_id":"286",
		"picture":"http:\/\/www.<api_domain.com>\/i\/300x300\/2015\/08\/28\/alexandreastier-eynn-jm32sd.jpg",
		"picture_relative":"2015\/08\/28\/alexandreastier-eynn-jm32sd.jpg",
		"picture_base64":"http:\/\/www.<api_domain.com>\/get\/picture_base64\/286\/300x300",
		"event_start_dt":"1443564000",
		"event_start_dt_iso":"2015-09-30",
		"event_end_dt":"1443564000",
		"event_end_dt_iso":"2015-09-30",
		"event_is_free":0,
		"fare_price_minimum":"37.900000",
		"fare_price_maximum":"37.900000",
		"currency_sign":"\u20ac",
		"currency_isocode":"EUR",
		"currency_name":"Euro",
		"organiser":[
			{
				"id":"10",
				"name":"Z\u00e9nith Amiens",
				"phone":"03 22 48 01 75",
				"email":"reservation@zenith-amiens.fr",
				"website":"http:\/\/www.zenith-amiens.fr",
				"organiser_categories":[
					{
						"organiser_category_id":"6",
						"organiser_category_name":"Salles de Spectacle"
					}
				],
				"address_location":"Z\u00e9nith Amiens",
				"address_number":"",
				"address_street_addr":"Avenue de l'Hippodrome",
				"address_addr_info":"",
				"address_latitude":"0.000000",
				"address_longitude":"0.000000",
				"city_id":"32505",
				"city_name":"Amiens",
				"city_postal_code":"80000",
				"state_code":"80",
				"state_name":"Somme"
			}
		],
		"accessibility":[
			{
				"accessibility_id":"1",
				"accessibility_icon_path":"http:\/\/www.amienscope.fr\/static\/im\/layout\/accessibility\/wheelchair.png",
				"accessibility_label":"Acc\u00e8s personnes \u00e0 mobilit\u00e9 r\u00e9duite",
				"accessibility_description":"L'\u00e9v\u00e9nement propose l'acc\u00e8s facilit\u00e9 aux personnes \u00e0 mobilit\u00e9 r\u00e9duite."
			}
		],
		"lang_name":"Fran\u00e7ais - France",
		"lang_locale":"fr_FR",
		"root_domain":"<api_domain.com>"
	},
	{
		"id":"19",
		"add_dt":"1441288602",
		"lastmod_dt":"1441289101",
		"highlighted":"0",
		"favorite_count":"218",
		"event_revision_add_dt":"1441288602",
		"event_title":"Trissotin ou Les Femmes Savantes",
		"event_description":"<p>Trissotin ou Les Femmes Savantes De Moli\u00e8re Mise en sc\u00e8ne, d\u00e9cor et costumes : Macha Make\u00efeff Portrait de famille au vitriol, l'avant-derni\u00e8re pi\u00e8ce de Moli\u00e8re et le plus grand succ\u00e8s de la troupe, Les Femmes Savantes sont repr\u00e9sent\u00e9es pour la premi\u00e8re fois en mars 1672 sur la sc\u00e8ne du Palais-Royal. Philaminte, sa fille Armande et sa belle-soeur B\u00e9lise, sous l'empire d'un faux savant, Trissotin, plus int\u00e9ress\u00e9 par l'argent que par le savoir, sont, c'est \u00e0 la mode, follement \u00e9prises de po\u00e9sie, de philosophie et de science...<\/p>\r\n<p>Chrysale, le mari de Philaminte, son fr\u00e8re Ariste et Henriette, la cadette des filles, n'osent pas s'opposer frontalement aux \u00abchim\u00e8res\u00bb de ces ma\u00eetresses femmes \u00e0 l'esprit boursoufl\u00e9, mais se d\u00e9solent de cette humanit\u00e9 \u00e0 la d\u00e9rive.<\/p>",
		"event_url_info":"http:\/\/www.maisondelaculture-amiens.com",
		"event_status_label":"Publi\u00e9",
		"event_status_id":"2",
		"event_status_visible":"1",
		"categories":[
			{
				"category_id":"2",
				"category_name":"Th\u00e9\u00e0tre",
				"icon_filename":"ic_play_circle_filled_48px.svg",
				"icon_distant_url":"http:\/\/api.<api_domain>\/static\/im\/layout\/icons\/material-icons-svg\/ic_play_circle_filled_48px.svg"
			}
		],
		"address_location":"Maison de la Culture d'Amiens",
		"address_number":"2",
		"address_street_addr":"Place L\u00e9on Gontier",
		"address_addr_info":"",
		"address_latitude":"49.894459",
		"address_longitude":"2.291910",
		"city_name":"Amiens",
		"city_uri":"amiens",
		"city_postal_code":"80000",
		"city_latitude":"49.900002",
		"city_longitude":"2.300000",
		"state_code":"80",
		"state_name":"Somme",
		"state_uri":"somme",
		"audience_id":"1",
		"audience_label":"Tout public",
		"picture_id":"174",
		"picture":"http:\/\/www.<api_domain.com>\/i\/300x300\/2015\/09\/03\/trissotin-ou-les-fem-mwwmqh.jpg",
		"picture_relative":"2015\/09\/03\/trissotin-ou-les-fem-mwwmqh.jpg",
		"picture_base64":"http:\/\/www.<api_domain.com>\/get\/picture_base64\/174\/300x300",
		"event_start_dt":"1444156200",
		"event_start_dt_iso":"2015-10-06",
		"event_end_dt":"1444168800",
		"event_end_dt_iso":"2015-10-07",
		"event_is_free":0,
		"fare_price_minimum":"30.900000",
		"fare_price_maximum":"30.900000",
		"currency_sign":"\u20ac",
		"currency_isocode":"EUR",
		"currency_name":"Euro",
		"organiser":null,
		"accessibility":[
			{
				"accessibility_id":"1",
				"accessibility_icon_path":"http:\/\/www.amienscope.fr\/static\/im\/layout\/accessibility\/wheelchair.png",
				"accessibility_label":"Acc\u00e8s personnes \u00e0 mobilit\u00e9 r\u00e9duite",
				"accessibility_description":"L'\u00e9v\u00e9nement propose l'acc\u00e8s facilit\u00e9 aux personnes \u00e0 mobilit\u00e9 r\u00e9duite."
			},
			{
				"accessibility_id":"2",
				"accessibility_icon_path":"http:\/\/www.amienscope.fr\/static\/im\/layout\/accessibility\/audioguide.png",
				"accessibility_label":"Audio-guide",
				"accessibility_description":"L'\u00e9v\u00e9nement propose l'utilisation d'un audio-guide pour les personnes malvoyantes."
			}
		],
		"lang_name":"Fran\u00e7ais - France",
		"lang_locale":"fr_FR",
		"root_domain":"<api_domain.com>"
	},
	...
]

Les événements issus d'une requête de listing par catégorie (ainsi que ceux issus d'une requête d'événements « À la Une » au demeurant) seront ordonnés par date de représentation, croissante.

Les événements sont donc ordonnés par date, à commencer par celui qui aura lieu le plus récemment. Dans le cas de deux événements ayant lieu le même jour, ils seront ordonnés par horaires de représentation.

Champ Type Description

id int Identifiant unique de l'événement

add_dt timestamp Date d'ajout (timestamp UNIX) de l'événement

lastmod_dt timestamp Date de dernière modification (timestamp UNIX) de l'événement

highlighted bool 1 ou 0 : L'événement est mis « À la Une »

favorite_count int Nombre de fois où cet événement a été marqué comme « Favori » par les utilisateurs, dans leur application Amienscope.

visit_count int Nombre de fois où le détail de cet événement a été ouvert dans l'application (ou nombre de visites). Utilisé pour le classement des événements les plus populaires.

event_revision_add_dt timestamp Date de dernière révision de l'événement (timestamp UNIX)

event_title str Titre de l'événement

event_description str Description de l'événement au format HTML

event_url_info URL URL d'informations complémentaires (site officiel, etc.)

event_status_label str Statut/État de l'événement (« Publié » ou « Annulé »)

event_status_id int Identifiant du statut/état de l'événement

event_status_visible bool 1 ou 0 : l'événement est visible ou non dans l'API

categories

array

Tableau d'objets contenant toutes les catégories auxquelles l'événement est attaché.

Chaque élément du tableau est composé des champs suivants :


`category_id`	int	Identifiant unique de la catégorie
`category_visible`	bool	Catégorie active (visible), ou désactivée. Une catégorie désactivée ne doit pas être affichée.
`category_name`	str	Nom complet 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)

address_location str Lieu où se déroule l'événement

address_number str Numéro de rue où se déroule l'événement

address_street_addr str Ligne 1 de l'adresse de l'événement (nom de la rue)

address_addr_info str Ligne 2 de l'adresse de l'événement (le cas échéant)

address_latitude float Latitude GPS du lieu où se déroule l'événement

address_longitude float Longitude GPS du lieu où se déroule l'événement

city_name str Nom de la ville où se déroule l'événement

city_uri str URI de la ville où se déroule l'événement

city_postal_code str Code postal de la ville où se déroule l'événement

city_latitude float Latitude GPS de la ville au sens général (centre-ville)

city_longitude float Longitude GPS de la ville au sens général (centre-ville)

state_code str Code du département dans lequel se déroule l'événement

state_name str Nom du département dans lequel se déroule l'événement

state_uri str URI du département dans lequel se déroule l'événement

audience_id int Identifiant unique de l'audience de l'événement (type de public visé)

audience_label str Nom/Libellé de l'audience de l'événement (type de public visé)

picture_id int Identifiant unique de l'image

picture URL URL de l'image associée à cet événement.
Remarque : le segment /300x300/ présent par défaut dans l'URL peut être librement modifié afin d'obtenir un visuel aux dimensions que vous souhaitez. L'image retournée sera automatiquement recadrée en fonction, et retournée aux dimensions demandées.

picture_relative str Chemin relatif de l'image associée à cet événement

picture_base64 URL URL de requête à effectuer sur l'API pour obtenir l'image au format base64.
Remarque : le segment /300x300/ présent par défaut dans l'URL peut être librement modifié ou supprimé afin d'obtenir un visuel aux dimensions que vous souhaitez. L'image retournée sera automatiquement recadrée en fonction, et retournée aux dimensions demandées.
Si vous supprimez ce segment, les données renvoyées par cette URL (l'image en base64) concerneront l'image non recadrée, dans ses dimensions originales.

event_start_dt timestamp Date de début de l'événement (timestamp UNIX)

event_start_dt_iso date Date de début de l'événement au format ISO/SQL

event_end_dt timestamp Date de fin de l'événement (timestamp UNIX)

event_end_dt_iso date Date de fin de l'événement au format ISO/SQL

event_is_free bool 1 ou 0 : L'événement est gratuit, ou ne l'est pas

fare_price_minimum float Tarif minimum pour cet événement, toutes représentations confondues

fare_price_maximum float Tarif maximum pour cet événement, toutes représentations confondues

currency_sign str Sigle monétaire de la devise utilisée pour les tarifs (défaut « € »)

currency_isocode str Code ISO monétaire de la devise utilisée pour les tarifs

currency_name str Nom lisible de la devise utilisée pour les tarifs

organiser

array

Tableau d'objets contenant le (ou les) organisateur(s) de cet événement. Si aucun organisateur n'est renseigné, ce champ sera null.

Chaque élément du tableau est composé des champs suivants :


`id`	int	Identifiant de l'organisateur
`name`	str	Nom de l'organisateur (ou de structure)
`phone`	str	Numéro de téléphone de l'organisateur
`website`	str	URL de site Internet de l'organisateur
`organiser_categories`	array	Tableau des catégories/types dont l'organisateur fait partie
`address_location`	str	Lieu où est basé cet organisateur
`address_number`	str	Numéro de rue de l'adresse de l'organisateur
`address_street_addr`	str	Rue de l'adresse de l'organisateur
`address_addr_info`	str	Complément d'adresse de l'organisateur
`address_latitude`	float	Latitude (GPS) de l'adresse de l'organisateur
`address_longitude`	float	Longitude (GPS) de l'adresse de l'organisateur
`city_id`	int	Identifiant de la ville de l'organisateur
`city_name`	str	Ville de l'organisateur
`city_postal_code`	str	Code postal de l'organisateur
`state_code`	str	Numéro de département de l'organisateur
`state_name`	str	Département de l'organisateur

accessibility

array

Tableau d'objets contenant les informations d'accessibilité auxquelles l'événement est attaché.

Chaque élément du tableau est composé des champs suivants :


`accessibility_id`	int	Identifiant unique de l'élément
`accessibility_icon_path`	str	Chemin de l'image (icône) correspondante
`accessibility_label`	str	Libellé de cette information d'accessibilité
`accessibility_description`	str	Description longue détaillant cette information d'accessibilité

lang_name str Nom lisible de la langue d'enregistrement de cet événement

lang_locale str Nom ISO de la langue d'enregistrement de cet événement

root_domain str Domaine parent sur l'API

Certains champs seront systématiquement renseignés (car obligatoires), mais nombreux sont les champs qui peuvent être vides. Si tel est le cas, le champ résultant contiendra tout simplement NULL.

Par défaut, en l'absence de paramètres de pagination, les listings sont limités à 20 événements à partir du premier.

Dans le cadre d'une navigation par pagination, il vous est possible d'ajouter des paramètres offet et limit à l'URL de la requête afin d'obtenir des listings paginés.

Les listings sont limités à 50 éléments au maximum afin de limiter l'utilisation des ressources serveur. Toute requête demandant un listing supérieur à 50 éléments sera automatiquement limitée.

GET https://api.amienscope.fr/get/events/<category_id>/<offset>,<limit>

Les paramètres offset et limit doivent être des entiers, et obligatoirement passés à l'URL sous le format « offset,limit ».

Par exemple, pour obtenir les 30 événements de la catégorie ID 4, à partir du 20ème, la requête effectuée sera la suivante :

https://api.amienscope.fr/get/events/4/20,30

/get/categories: Catégories d'événements utilisées dans l'API
/get/organisers: Organisateurs d'événements connus de l'API
/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

Pagination et limitation du listing : offset et limit

Requête sur l'API

Voir aussi