Documentation simplifiée des Web Services HAL LES REFERENTIELS. 1. Référentiel Laboratoire. 2. Référentiel des Affiliations

Transcription

1 Documentation simplifiée des Web Services HAL LES REFERENTIELS 1. Référentiel Laboratoire Ce référentiel liste les différents laboratoires connus de HAL. Un laboratoire est caractérisé par les informations suivantes : id (int) : Identifiant unique du laboratoire name (string) : Nom du laboratoire shortname (string) : Sigle du laboratoire valid (int) : Etat du laboratoire : - 1 laboratoire valide - 99 laboratoire ancien (fermé, n existant plus) url (string) : adresse du site web du labo address (string) : Coordonnées postales du labo pays (string) : identifiant du pays (code ISO ) affi (ArrayOfStrings) : affiliations du laboratoire (institution, université, grande école, partenaire privé) Les différentes méthodes permettant d accéder au référentiel des laboratoires vont retourner un objet de type LabStruct ou un tableau d objets LabStruct. Cet objet va contenir toutes les informations listées précédemment définissant un laboratoire. - getreflab : Cette première méthode va retourner la totalité du référentiel des laboratoires. - getreflab _byid : Accès aux informations d un laboratoire à partir de son identifiant unique. - getreflab _byname : Accès au référentiel des laboratoires à partir d un nom de labo donné. - getreflab byshortname : Accès au référentiel des laboratoires à partir d un sigle de labo donné. - getreflab byaffi : Accès au référentiel des laboratoires à partir des affiliations d un labo données. 2. Référentiel des Affiliations Le référentiel des affiliations est constitué de tous les organismes qui peuvent être associés à un laboratoire. Dans la base HAL, les affiliations sont divisées en 4 sousréférentiels : institution : Les institutions (CNRS, CEA, ). C est dans ce listing que se trouvera le code unité d un laboratoire CNRS university : Les universités school : Les grandes écoles privatepartner : Les partenaires privés. Les méthodes permettant d accéder à ce référentiel retournent un tableau de string. 1

2 - getrefaffi : Cette première méthode va retourner la totalité du référentiel des affiliations. On peut récupérer uniquement le référentiel des universités, ou des institutions, - getrefaffi_byname : Accès au référentiel des affiliations à partir du nom. 3. Référentiel des Instances Hal dispose de plusieurs portails d entrée différents (instances), chacun dans un domaine spécifique avec des métadonnées spécifiques, aussi ce référentiel permet d obtenir toutes les instances de HAL. - getrefinstance : Cette première méthode va retourner la totalité du référentiel des instances disponibles dans HAL. 4. Référentiel des organismes de thèses Ce référentiel contient toutes les informations suivantes sur les organismes de thèses : id (int) : identifiant unique libelle (string) : nom de l université academy (string) : académie url (string) : adresse du site Web de l'organisme pays (string) : identifiant du pays (code ISO ) valid (int) : Etat de l organisme ( 1 organisme valide ; 0 organisme pas encore validé ; 99 organisme non valide (ancien organisme)) - getreforgthe : Cette première méthode va retourner la totalité du référentiel des organismes de thèses disponibles dans HAL. - getreforgthe_byname : Accès au référentiel des organismes de thèses à partir du nom. 5. Référentiel des revues Une revue est définie par : name (string) : nom complet de la revue shortname (string) : nom abrégé de la revue Les méthodes suivantes retournent un tableau d objets de type ReviewStruct. Cet objet va contenir le nom et le sigle de la revue. - getrefreview : retourne la liste des revues disponibles sur HAL. - getreview_byname : Accès au référentiel des revues à partir du nom. - getrefreview_byshortname : Accès au référentiel des revues à partir du nom abrégé. 6. Référentiel des écoles doctorales Les méthodes suivantes permettent de récupérer la liste des écoles doctorales. Ces méthodes retournent un tableau d objet SchoolStruct. Cet objet va contenir le nom de l école (name) ainsi que l organisme de thèse associé (orgthe). 2

3 - getrefschool : retourne la liste des écoles doctorales disponibles sur HAL. - getrefschool_byname : Accès au référentiel des écoles doctorales à partir du nom. - getrefschool_byorgthe : Accès au référentiel des écoles doctorales à partir de l organisme de thèses. 7. Référentiel des domaines de dépôt Un article peut être déposé dans un ou plusieurs domaines. Ce référentiel contient la liste des domaines qui peuvent être choisi pour déposer un article. Un domaine est défini par : code (string) : identifiant du domaine codeparent(string) : code 'père' du domaine deposable (boolean) : prend les valeurs 'TRUE' ou 'FALSE' suivant s'il est permis de déposer dans ce domaine ou pas. havenext (boolean) : prend les valeurs 'TRUE' ou 'FALSE' libelle (string) : libellé d un domaine Les méthodes suivantes permettent d accéder au référentiel des domaines de dépôt : - getrefsubject : Récupération de la liste des domaines du référentiel. - getrefsubject_bycode : Récupération des informations sur un domaine de dépôt à partir de son identifiant (code). - getrefsubject_bycodeparent : Récupération de la liste des informations sur les domaines de dépôt à partir du codeparent (identifiant du domaine supérieur d un domaine) - getrefsubject_bylibelle : Récupération de la liste des informations sur les domaines de dépôt à partir du libellé. 8. Référentiel des formats de dépôt - getrefformat : Récupération de la liste des domaines du référentiel. 9. Référentiel de la visibilité d un dépôt - getrefdatevisible : Lors du dépôt d un article, l auteur peut vouloir définir une période d embargo pour lequel le document ne sera pas visible immédiatement. La méthode getrefdatevisible retourne les différentes périodes d embargo disponibles. 10. Référentiel des collections - getrefcollection : Retourne pour un utilisateur donné la liste des collections dont il est tamponneur. 11. Référentiel des types de publication - getreftypepubli : Liste des types de publications déposables pour une instance de HAL donnée. 3

4 - getreftypepubli_bydoc : retourne le type de publication d un article déposé dans HAL. 12. Référentiel des Métadonnées Une métadonnée est caractérisée par : name (string) : identifiant de la métadonnée type (string) : type (string, tableau, ) comment (string) : commentaires sur la métadonnée libelle (string) : libellé required (Boolean) : indique si c est une métadonnée obligatoire lors d un dépôt d article Les méthodes suivantes permettent d accéder au référentiel des métadonnées. Pour une instance donnée, il est possible de lister les métadonnées à renseigner pour un dépôt. - getrefmetadata_bydoc : retourne la liste des métadonnées d un article déposé dans HAL - getrefmetadata_byinstance : retourne la liste des métadonnées pour une instance de HAL donnée. - getrefmetadata_bytypepubli : retourne la liste des métadonnées pour un type de publication d une instance de HAL donnée. 4

5 LES ARTICLES Les différentes méthodes permettant de déposer, modifier etc des articles dans HAL vont retourner un objet de type ArticleIdentStruct. Cet objet est caractérisé par les informations suivantes : identifiant (string) : Identifiant de l article version (int) : Numéro de version passwd (string) : mot de passe de l article Les méthodes suivantes permettent de déposer, modifier etc des articles dans HAL - upload : dépôt d un article - cross : ajout de domaines - replace : dépôt d une nouvelle version - addfile : ajout de fichier à une notice - update : modifications des métadonnées communes - jref : Modification du type de publication et des métadonnées spécifiques à ce type de publication. - addcollection : ajout d articles dans une collection. 5