Télécharger la description au format OpenApi YAML (Swagger)

API Mir@bel

Web-service REST pour interroger Mir@bel
Version 1.0.0

Données sous Licence Ouverte, compatible ODC-BY et CC-BY 2.0. Réutilisation possible des données à condition d'en mentionner l'origine.

Licence des données

Licence ouverte : http://www.etalab.gouv.fr/licence-ouverte-open-licence

Format des réponses

Pour le moment, seul le format JSON est possible, mais XML sera probablement ajouté comme alternative.

Liste des chemins

Tous les chemins doivent être préfixés par /api.

Détail des actions

/revues

GET /revues

Titre
Liste de revues
Description

Liste des revues possédées par un partenaire de Mir@bel, et décrites par leur dernier titre. L'accès est restreint aux partenaires de Mir@bel.

URL
GET /api/revues
Paramètres
Nom Description Lieu Requis ? Type, format
partenaireClé privée du partenairequeryOuiinteger
ressourceidIdentifiant numérique d'une ressource de Mir@bel (par ex. 3 pour Cairn.info)queryNoninteger
possessionN'afficher que les revues possédées par ce partenaire.queryNonboolean
Réponses
Code HTTP Description Schema
200liste de titres[ → Titre ]
defaultErreurErreur

/revues/detail

GET /revues/detail

Titre
Détail d'une revue
Description

Les infos que Mir@bel fournit sur une revue. Donner au moins un paramètre dans la requête pour sélectionner la revue. Par exemple, /revues/details?issn=0764-7565 montrera le titre actif de cette revue, qui n'a plus l'ISSN recherché.

URL
GET /api/revues/detail
Paramètres
Nom Description Lieu Requis ? Type, format
titreidIdentifiant numérique du titre.queryNoninteger
revueidIdentifiant numérique de la revue.queryNoninteger
issnNuméro ISSN (ou ISSN-e ou ISSN-l) de la forme XXXX-XXXXqueryNonstring
worldcatIdentifiant numérique de Worldcat.queryNoninteger
sudocIdentifiant numérique PPN de SUDOC.queryNoninteger
titreTitre.queryNonstring
sigleSigle.queryNonstring
Réponses
Code HTTP Description Schema
200Détail d'un titre (le dernier de la revue){ → Titre }
defaultErreurErreur

/titres/detail

GET /titres/detail

Titre
Détail d'un titre
Description

Les infos que Mir@bel fournit sur un titre. Donner au moins un paramètre dans la requête pour sélectionner le titre. Par exemple, /titres/details?issn=0764-7565 pour trouver le titre qui a l'ISSN 1660-7880.

URL
GET /api/titres/detail
Paramètres
Nom Description Lieu Requis ? Type, format
titreidIdentifiant numérique du titre.queryNoninteger
revueidIdentifiant numérique de la revue.queryNoninteger
issnNuméro ISSN (ou ISSN-e ou ISSN-l) de la forme XXXX-XXXXqueryNonstring
worldcatIdentifiant numérique de Worldcat.queryNoninteger
sudocIdentifiant numérique PPN de SUDOC.queryNoninteger
titreTitre.queryNonstring
sigleSigle.queryNonstring
Réponses
Code HTTP Description Schema
200Détail d'un titre{ → Titre }
defaultErreurErreur

Modèles de données

Titre

idinteger
Identifiant unique attribué par Mir@bel à ce titre.
revueIdinteger
Identifiant unique attribué par Mir@bel à cette revue.
obsoleteParinteger
Éventuel identifiant numérique du titre qui a remplacé celui-ci dans la revue.
titrestring
Titre (sans son éventuel préfixe comme "L'").
prefixestring
Préfixe du titre (par exemple "L'").
dateDebutstring, date
Date de début de ce titre.
dateFinstring, date
Date de fin de ce titre.
worldcatinteger
Identifiant numérique de Worldcat.
sudocinteger
Identifiant numérique PPN de SUDOC.
issnstring
Numéro ISSN de la forme XXXX-XXXX
issnlstring
Numéro ISSN de la forme XXXX-XXXX
issnestring
Numéro ISSN de la forme XXXX-XXXX
urlstring
Site web de la revue. URL publique, hors Mir@bel.
url_revue_mirabelstring
Page web de la revue sur le site de Mir@bel.
periodicitestring
Périodicité.
electroniqueboolean
La revue est-elle uniquement numérique, sans édition sur papier.
langues[ string ]
Liste des langues de ce titre, par leurs codes ISO à 3 lettres.
derModifstring, date
Date de la dernière modification dans Mir@bel.

Erreur

codeinteger, int32
Code HTTP de l'erreur
messagestring
Description détaillée du problème
fieldsstring
Éventuels champs créant un trouble dans la requête
details?
Éventuels détails sur l'erreur.