API PMB: Groupe pmbesOPACGeneric

Types déclarés ou référencés

1. shelf

   Nom du type:
   shelf
   Description:
   Décrit une étagère
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   id type integer

   Id de l'étagère

   name type string

   Nom de l'étagère

   comment type string

   Commentaire de l'étagère

   
   
   
   Sommaire

2. location

   Nom du type:
   location
   Description:
   Décrit une localisation
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   location_id type integer

   Id de la localisation

   location_caption type string

   Libellé de la localisation

   
   
   
   Sommaire

3. section

   Nom du type:
   section
   Description:
   Décrit une section
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   section_id type integer

   Id de la section

   section_location type integer

   Localisation de la section

   section_caption type string

   Libellé de la section

   section_image type string

   Image associée à la section

   
   
   
   Sommaire

4. location_and_sections

   Nom du type:
   location_and_sections
   Description:
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   location type location location_id type integer        Id de la localisation location_caption type string        Libellé de la localisation

   sections type tableau de section section_id type integer        Id de la section section_location type integer        Localisation de la section section_caption type string        Libellé de la section section_image type string        Image associée à la section

   
   
   
   Sommaire

5. unimarc_notice

   Nom du type:
   unimarc_notice
   Description:
   Désigne une notice unimarc
   Localisation:
   Importé du groupe pmbesSpecialTypes
   Contenu:

   id type string

   L'id de la notice

   header type tableau de la structure suivante: name type string        Le nom du champ value type string        La valeur du champ

   L'entête unimarc

   f type tableau de la structure suivante: c type string         ind type string         id type string         value type string         s type tableau de la structure suivante:         c type string         value type string

   Les champs f

   
   
   
   Sommaire

Méthodes

1. list_shelves

   Nom de la méthode:
   list_shelves
   Description:
   Liste les différentes étagères visibles dans l'opac
   Version:
   1.0
   Description des entrées:

   OPACUserId type integer

   Id d'un emprunteur, pour vérifier les droits d'accès sur cette étagère. -1: Ne pas tenir compte 0: emprunteur anonyme x: id de l'emprunteur

   Description des retours:

   shelves type tableau de shelf id type integer        Id de l'étagère name type string        Nom de l'étagère comment type string        Commentaire de l'étagère

   Les différentes étagères

   
   
   
   Sommaire

2. retrieve_shelf_content

   Nom de la méthode:
   retrieve_shelf_content
   Description:
   Liste les différentes notices contenues dans une étagère
   Version:
   1.0
   Description des entrées:

   shelf_id type integer

   OPACUserId type integer

   Id d'un emprunteur, pour vérifier les droits d'accès sur les notices. -1: Ne pas tenir compte 0: emprunteur anonyme x: id de l'emprunteur

   Description des retours:

   Cette fonction tient compte des différents droits d'accès applicables à l'emprunteur

   shelf_content type tableau de integer

   Ids des notices

   
   
   
   Sommaire

3. list_locations

   Nom de la méthode:
   list_locations
   Description:
   Liste les différentes localisations de l'OPAC
   Version:
   1.0
   Description des entrées:
   Description des retours:

   locations type tableau de location location_id type integer        Id de la localisation location_caption type string        Libellé de la localisation

   Les différentes localications

   
   
   
   Sommaire

4. get_location_information

   Nom de la méthode:
   get_location_information
   Description:
   Renvoie les informations associées à une localisation
   Version:
   1.0
   Description des entrées:

   location_id type integer

   L'id de la localisation

   Description des retours:

   location type location location_id type integer        Id de la localisation location_caption type string        Libellé de la localisation

   Les informations

   
   
   
   Sommaire

5. get_location_information_and_sections

   Nom de la méthode:
   get_location_information_and_sections
   Description:
   Renvoie les informations et les différentes sections associées à une localisation
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • get_location_information du groupe pmbesOPACGeneric, en version 1.0
   • list_sections du groupe pmbesOPACGeneric, en version 1.0
   Description des entrées:

   location_id type integer

   L'id de la localisation

   Description des retours:

   result type location_and_sections location type location_id type integer        Id de la localisation location_caption type string        Libellé de la localisation sections type tableau de section

   
   
   
   Sommaire

6. list_sections

   Nom de la méthode:
   list_sections
   Description:
   Liste les différentes sections visibles de l'OPAC
   Version:
   1.0
   Description des entrées:

   location type integer

   La localisation des sections

   Description des retours:

   sections type tableau de section section_id type integer        Id de la section section_location type integer        Localisation de la section section_caption type string        Libellé de la section section_image type string        Image associée à la section

   Les différentes sections

   
   
   
   Sommaire

7. get_section_information

   Nom de la méthode:
   get_section_information
   Description:
   Renvoie les informations associées à une section
   Version:
   1.0
   Description des entrées:

   section_id type integer

   L'id de la section

   Description des retours:

   section type section section_id type integer        Id de la section section_location type integer        Localisation de la section section_caption type string        Libellé de la section section_image type string        Image associée à la section

   Les informations

   
   
   
   Sommaire

8. get_all_locations_and_sections

   Nom de la méthode:
   get_all_locations_and_sections
   Description:
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • get_location_information du groupe pmbesOPACGeneric, en version 1.0
   • list_sections du groupe pmbesOPACGeneric, en version 1.0
   Description des entrées:
   Description des retours:

   locations type tableau de location_and_sections location type location_id type integer        Id de la localisation location_caption type string        Libellé de la localisation sections type tableau de section

   
   
   
   Sommaire

9. is_also_borrowed_enabled

   Nom de la méthode:
   is_also_borrowed_enabled
   Description:
   Permet de savoir si la fonction "Autre Lecture" est activée ou non
   Version:
   1.0
   Description des entrées:
   Description des retours:

   result type boolean

   Si la fonction est activée ou non

   
   
   
   Sommaire

10. also_borrowed

    Nom de la méthode:
    also_borrowed
    Description:
    Renvoie les autres lectures associées à une notice
    Version:
    1.0
    Description des entrées:

    notice_id type integer

    L'id de la notice

    bulletin_id type integer

    L'id du bulletin

    Description des retours:

    notice_references type tableau de la structure suivante: notice_id type integer        L'id de la notice notice_title type string        Le titre de la notice notice_author type string        L'auteur de la notice

    Les différentes autres lectures

    
    
    
    Sommaire

11. get_infopage

    Nom de la méthode:
    get_infopage
    Description:
    Version:
    1.0
    Description des entrées:

    infopage_id type integer

    js_subst type string

    encoding type string

    Description des retours:

    result type string

    
    
    
    Sommaire

12. get_marc_table

    Nom de la méthode:
    get_marc_table
    Description:
    Récupère les informations contenues dans les fichiers xml de paramètrage de PMB. Permet d'avoir notamment les libellés corespondants à des codes utilisés dans PMB
    Version:
    1.0
    Description des entrées:

    type type string

    Type d'information souhaitée: country -> Pays icondoc -> Images associées aux notices icondoc_big -> Images associées aux notices (grand format) lang -> Langues doctype -> Types de documents recordtype -> Type de notices function -> Fonctions d'auteurs section_995 -> Section d'exemplaires typdoc_995 -> Support d'exemplaires codstatdoc_995 -> Code stat d'exemplaire diacritique -> Caractères diacritiques nivbiblio -> Niveau bibliographique relationtypeup -> Lien entre notice fille -> mère relationtypedown -> Lien entre notice mère -> fille relationtype_aut -> Lien entre autorité mère -> fille relationtype_autup -> Lien entre autorité fille -> mère relationtypeup_unimarc -> Code unimarc du champ pour les liens fille -> mère relationtypedown_unimarc -> Code unimarc du champ pour les liens mère -> fille

    Description des retours:

    result type array

    Tableau avec les associations [code] => Libellé/valeur

    
    
    
    Sommaire