Version 1.6
Sommaire | ||
---|---|---|
|
Introduction
En 2015-2016, dans le cadre du projet SADVR (service d’accès aux données de la Vitrine-Recherche), une API REST a été développée par l’équipe du Centre d’expertise numérique pour la recherche (CEN-R) afin de redistribuer les données contenues dans le dépôt Vitrine-Recherche.
...
Le Dictionnaire de données recense l'ensemble des données contenues dans la réponse JSON de l'API REST.
Changements par rapport aux versions antérieures
Pour obtenir la liste de principaux changements effectuées d'une version à l'autre de l'API, voir la page de recension des changements : API REST - Changements par rapport aux versions antérieures.
Service des ressources
Le Service des ressources permet d’exposer l’ensemble des valeurs possibles pour 6 des 7 paramètres proposés par le Service de recherche d’identifiant pérenne.
Information | Champ (réponse JSON) | Commentaires |
---|---|---|
Faculté |
| |
Département |
| |
Fonction |
| |
Programme |
| |
Domaine d'étude |
| |
Expertise de recherche |
(ci-dessous mots-clés seulement)
| Il faut fournir dans la requête au moins un paramètre Les valeurs du champ 'volet' consistent dans les noms des tables, en langage humain, d'où provient le terme d'expertise, soit:
La distinction entre un continent et une sous-région se fait par l'intermédiaire du champ 'Niveau' de la table 'Continent', le niveau 1 étant le continent, le niveau 2, la sous-région. Les départements, facultés et unités de recherche ne sont pertinents que pour l'expertise du volet 'Mot-clé'. Les mots-clés, continents, sous-régions, pays et périodes chronologiques sont multilingues. Le nombre d'individus correspond à la quantité de personnes associées à un terme particulier, la valeur retournée étant systématiquement un entier. Si aucune personne n'est associée au terme, la valeur '0' sera retournée. S'agissant des mots-clés, l'API retourne les occurrences provenant de tous les départements et toutes les facultés. Ainsi, il est possible d'évaluer l'utilisation globale d'un mot-clé au sein du corps professoral entier (et non que relativement au département ou à à la faculté pour lequel on obtient l'exposition de l'expertise. |
Code et nom des langues parlées et écrites |
| Nouveau avec la version 1.7 La liste des langues parlées ou écrites par au moins une personne. Si l'élément oral = true, cela indique qu'au moins une personne maîtrise cette langue à l'oral. De même, si ecrit = true, au moins une personne maîtrise la langue à l'écrit. |
Disciplines |
| Nouveau avec la version 1.7 |
Établissements affiliés à l'UdeM |
| Nouveau avec la version 1.7 |
Secteurs de recherche |
| Nouveau avec la version 1.7 |
Règles d'affaire de l'exposition de l'expertise de recherche
Il n'est pas possible d'obtenir l'exposition globale de l'expertise, pour toutes les facultés et tous les départements confondus. Il faut préciser une (et une seule) faculté ou un ou des départements. On peut préciser une faculté ET un département, mais le département doit faire partie de la faculté indiquée. Dans ce cas, le fait d'inclure la faculté est inutile car le service retourne alors les mots-clés associés au département (et non tous les mots-clés utilisés par l'ensemble des départements de la faculté). Le service permet l'exposition de l'expertise conjointe de plusieurs départements. Toutefois, ceux-ci doivent tous faire partie de la même faculté.
Service de recherche d’identifiant pérenne (idsadvr)
Individu
Information | Champ (réponse JSON) |
---|---|
Identifiant SADVR | idsadvr |
Prénom | prenom |
Nom de famille | nom |
Titre de fonction | fonction |
Code SAD de la fonction | fonctionCodeSAD |
Unité administrative | uniteAdmin |
Courriel | courriel |
Visuel officiel | visuelOfficiel |
Ancre | ||||
---|---|---|---|---|
|
Information | Champ (réponse JSON) | Commentaire |
---|---|---|
Identifiant SADVR | idsadvr | |
Nom de l'unité | nom | |
Acronyme de l'unité | acronyme | |
Responsable(s)
| responsables
| L'élément fonctionResp est une nouveauté de la version 1.7 |
Visuel officiel | visuelOfficiel | |
Unités de rattachement | unitesRattachement
| |
Expertise | expertise
| Nouveau avec la version 1.7 Pour plus d'explications, voir la description de l'expertise relative au service INFO pour les unités de recherche, ci-dessous. |
Ancre | ||||
---|---|---|---|---|
|
Service de recherche d’identifiant pérenne étendu pour les individus
Ce service permet d’obtenir davantage d’information sur les individus en une seule requête que le service de recherche de base. Il s’applique uniquement aux individus.
Information | Champ (réponse JSON) | Commentaire |
---|---|---|
Identifiant SADVR | idsadvr | |
Prénom | prenom | |
Nom de famille | nom | |
Affiliations
| affiliations
| Peut avoir plusieurs affiliations |
Téléphones | telephones
| Autres téléphones que les téléphones liés aux fonctions (ex. catégorie = télécopieur) |
Courriels | courriels
| Autres courriels que le courriel institutionnel lié à la fonction (ex. : catégorie = Personnel) |
Établissements affiliés | etablissementsAffilies | |
Visuel officiel | visuelOfficiel | |
Expertise
| expertise
| Même contenu que celui trouvé dans le profil de l’individu (service Nouveau dans la version 1.7 : ajout de l'élément uid aux différents termes d'expertise. |
Activité des profils | urlVitrine
| Le bloc « nom, url » est répété deux fois, l’un pour la Vitrine de la recherche et l’autre pour le répertoire des experts à l’intention des médias. Si le profil n’est pas actif, url = null. |
Recrutement en recherche | recrutementRecherche | Si l’individu affiche une offre de recrutement dans son profil, l’attribut prend la valeur true, sinon, false. |
Service de récupération de données par le biais d’un identifiant pérenne (idsadvr)
Individu
Information | Champ (réponse JSON) | Multiple | Multilingue | Commentaires |
---|---|---|---|---|
Identifiant pérenne | idsadvr | |||
Nom
|
| Les deux formes du nom de l'individu (prénom, nom) ne sont fournies que si elles sont différentes. | ||
Sexe | sexe | |||
Institution
|
| Le nom du pays de l'institution n'est fourni qu'en français. | ||
Consentement | consentement
| Le consentement est exposé pour chacun des répertoires où l'individu peut apparaître. | ||
Affichage Web | affichageWeb
| L'affichage Web est exposé pour chacun des répertoires où l'individu peut apparaître. | ||
Langue maitrisée
| langues
| Le nom de la langue est fourni en français. Le nom du médium de communication est fourni en français. | ||
Courriel
| courriels
| |||
Affiliation
| affiliations
| L'exclusion indique que l'individu souhaite que l'information soit masquée, lors de l'affichage Web. | ||
Présence Web
| presencesWeb
| |||
Téléphone
| telephones
| |||
Établissement affilié | etablissementsAffilies
| |||
Formation
| formations
| Le nom du pays est fourni en français. Il peut y avoir plusieurs disciplines et institutions pour une même formation. | ||
Biographie | biographie
| |||
Recrutement en recherche | recrutementRecherche
| |||
Activité d'enseignement
| activiteEnseignement
| / | Les trimestre et année d'un cours ne doivent être fournis que pour les cours dont la source de données est Synchro (SAD). Les domaine d'étude, groupe programme et programme sont multilingues. | |
Unité de recherche
| unitesRecherche
| Pour le lien avec l'unité de recherche, l'étiquette "responsable" indique à l'aide d'un booléen si l'individu est responsable ou pas, le fait qu'il ne le soit pas impliquant forcément qu'il est membre. 0 = non On donne le titre de fonction au masculin et au féminin. | ||
Projet de recherche
| projetsRecherche
| / | Le financement peut être multiple. Les pays et période chronologiques peuvent être multiples. La description du projet de recherche (contenu) est multilingue. | |
Activité de recherche
| activitesRecherche
| / | Les partenaires peuvent être multiples. Les pays et période chronologiques peuvent être multiples. La description de l'activité de recherche (contenu) est multilingue. Les données importées de Papyrus sont identifiées dans la source de données. | |
Publication | publication | |||
Communication | communication | |||
Expertise
| expertise
| / | Les secteurs, disciplines, mot-clés, continents, pays et périodes chronologiques peuvent être multiples. Les description de l'expertise (contenu) et en quelques mots (phraseCle) sont multilingues. Les secteur de recherche, discipline, mot-clé, continent, pays et période chronologique sont multilingues. Sous continents, la categorie Nouveau dans la version 1.7 : ajout de l'élément uid aux différents termes d'expertise. | |
Expertise média
| expertiseMedia
| La description de l'expertise média et information supplémentaire sont multilingues. | ||
Prix et distinction
| prix
| / | Les prix décrits dans le champ libre (dans l’élément « autre ») représentent un contenu multilingue. | |
Information supplémentaire
| infosSupplementaires
| |||
Visuel
| visuels
| / | La légende du visuel est multilingue. | |
Activité de promotion
| activitesPromotion
| / | Les secteurs et disciplines peuvent être multiples. La description de l'activité de promotion (contenu) est multilingue. |
Unité de recherche
Consentement | consentement
| Le consentement est exposé pour chacun des répertoires où l'unité de recherche peut apparaître. | ||
Affichage Web | affichageWeb
| L'affichage Web est exposé pour chacun des répertoires où l'individu peut apparaître. | ||
Identifiant pérenne | idsadvr | |||
Type | type | |||
Nom | nom | |||
Acronyme | acronyme | |||
Source de financement Description du financement | financement
| |||
Courriel
| courriels
| |||
Téléphone
| telephones
| |||
Présence Web
| presenceWeb
| |||
Unité de rattachement
| unitesRattachement
| |||
Affiliation
| affiliations
| Nouveau avec la version 1.7 : on distingue maintenant les établissements affiliés et les unités de recherche hors UdeM. Auparavant, ces entités étaient regroupées indistinctement dans l'élément etablissementsAffilies . | ||
Équipe
| equipe
| Les personnes hors UdeM se distinguent par un idsadvr = null . et la présence possible d'un lien vers leur profil institutionnel. | ||
Expertise / Description détaillée | descriptionActivitesRecherche
| |||
Axe de recherche
| axeRecherche
| / | La description des axes de recherche est multilingue. | |
Expertise
| expertise
| Les secteurs, continents, pays et périodes chronologiques peuvent être multiples. Les secteur de recherche, continent, pays et période chronologique sont multilingues. Nouveau avec la version 1.7 : ajout des disciplines et un identifiant pour les différents termes d'expertises. | ||
Information supplémentaire
| infosSupplementaires
| / | La description est multilingue. | |
Visuel
| visuels
| / | La légende du visuel est multilingue.
| |
Publications |
| |||
Communications |
| |||
Adresses
| adresses
|
Service de moteur de recherche
Pour la recherche dans les données de la Vitrine des professeurs et du répertoire des experts, ce service retourne les mêmes informations que le service de recherche d’identifiant pérenne étendu pour les individus (/idext/individu). S'agissant des données sur les unités de recherche, la réponse retourne les mêmes informations que le service de recherche d’identifiant pérenne (/id/uniterech).