API PMB: Groupe pmbesOPACEmpr

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

1. reader

   Nom du type:
   reader
   Description:
   Décrit un emprunteur
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   id type integer

   id de l'emprunteur

   cb type string

   Code-barres

   personal_information type structure firstname type string        Prénom lastname type string        Nom de famille address_part1 type string        Adresse (ligne 1) address_part2 type string        Adresse (ligne 2) address_cp type integer        Code postal address_city type string        Ville phone_number1 type string        Numéro de téléphone 1 phone_number2 type string        Numéro de téléphone 2 email type string        Email birthyear type integer        Année de naissance sex type integer        Sexe

   Informations administratives de l'emprunteur

   location_id type integer

   Id de la localisation

   location_caption type string

   Libellé de la localisation

   adhesion_date type string

   Date de création de l'abonnement

   expiration_date type string

   Date d'expiration de l'abonnement

   
   
   
   Sommaire

2. loan

   Nom du type:
   loan
   Description:
   Décrit un prêt
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   empr_id type integer

   Id de l'emprunteur associé au prêt

   notice_id type integer

   Id de la notice du document

   bulletin_id type integer

   Id du bulletin si c'est un bulletin de périodique

   expl_id type integer

   Id de l'exemplaire

   expl_cb type string

   Code-barres de l'exemplaire

   expl_support type string

   Support de l'exemplaire

   expl_location_id type integer

   Id de la localisation de l'exemplaire

   expl_location_caption type string

   Libellé de la localisation

   expl_section_id type integer

   Id de la section de l'exemplaire

   expl_section_caption type string

   Libellé de la section

   expl_libelle type string

   Libellé de l'exemplaire

   loan_startdate type string

   Date de prêt

   loan_returndate type string

   Date de retour du prêt

   
   
   
   Sommaire

3. resa

   Nom du type:
   resa
   Description:
   Décrit une réservation
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   resa_id type integer

   Id de la réservation

   empr_id type integer

   Id de l'emprunteur

   notice_id type integer

   Id de la notice associée

   bulletin_id type integer

   Id du bulletin associé

   resa_rank type integer

   Rang de la réservation

   resa_dateend type string

   Date de fin de validité de la réservation

   resa_retrait_location_id type integer

   Id de la localisation de retrait de la réservation

   resa_retrait_location type string

   Libellé de la localisation de retrait de la réservation

   
   
   
   Sommaire

4. suggestion

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

   sugg_id type string

   sugg_date type string

   Date de la suggestion

   sugg_title type string

   Titre de l'oeuvre de la suggestion

   sugg_editor type string

   Editeur de l'oeuvre de la suggestion

   sugg_author type string

   Auteur de l'oeuvre de la suggestion

   sugg_barcode type string

   sugg_price type string

   sugg_url type string

   sugg_comment type string

   sugg_date type string

   sugg_source type integer

   sugg_source_caption type string

   sugg_category type integer

   sugg_category_caption type string

   sugg_location type integer

   sugg_state type string

   sugg_state_caption type string

   Statut de la suggestion

   
   
   
   Sommaire

5. 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

6. abonnement

   Nom du type:
   abonnement
   Description:
   Décrit un abonnement (DSI)
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   abonnement_id type integer

   Id de l'abonnement

   abonnement_type type string

   Type de l'abonnement, PUBLIC ou PRIVATE

   abonnement_title type string

   Titre de l'abonnement

   abonnement_lastsentdate type string

   Date de dernier envoi

   abonnement_equation_human type string

   Equation de recherche

   abonnement_notice_count type integer

   Nombre de notices

   empr_subscriber type boolean

   Précise si l'emprunteur est souscripteur de l'abonnement

   
   
   
   Sommaire

7. search_field

   Nom du type:
   search_field
   Description:
   Décrit un champ de recherche
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   id type string

   Id du champ de recherche

   label type string

   Description du champ

   type type string

   Type du champ

   operators type tableau de la structure suivante: id type string        Id de l'opération label type string        Affichage de l'opérateur

   Opérateurs du champ

   values type tableau de la structure suivante: value_id type integer        Id de la valeur value_caption type string        Affichage de la valeur

   Si fetch_values est à true et si le type du champ propose des valeurs prédéfinies:

   fieldvar type tableau de la structure suivante: label type string        Description du paramètre name type string        Nom du paramètre type type string        Type du paramètre values type tableau de la structure suivante:        Si valeurs prédéfinies value_id type integer        Valeur value_caption type string        Libellé

   Si le champ contient des paramètres modifiables par l'utilisateur

   
   
   
   Sommaire

8. item

   Nom du type:
   item
   Description:
   Décrit un exemplaire
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   id type integer

   Id de l'exemplaire

   cb type string

   Code-barres de l'exemplaire

   cote type string

   Cote de l'exemplaire

   location_id type integer

   Id de la localisation de l'exemplaire

   location_caption type string

   Libellé de la localisation de l'exemplaire

   section_id type integer

   Id de la section de l'exemplaire

   section_caption type string

   Libellé de la section de l'exemplaire

   statut type string

   Statut de l'exemplaire

   support type string

   Support de l'exemplaire

   situation type string

   Situation de l'exemplaire

   codestat type string

   
   
   
   Sommaire

9. explNum

   Nom du type:
   explNum
   Description:
   Décrit un exemplaire numérique
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   id type integer

   Id de l'exemplaire numérique

   noticeId type integer

   Id de la notice associée à l'exemplaire numérique

   bulletinId type integer

   Id du bulletin associé à l'exemplaire numérique

   name type string

   Nom de l'exemplaire numérique

   mimetype type string

   Mimetype de l'exemplaire numérique

   extention type string

   filename type string

   Nom du fichier de l'exemplaire numérique

   filesize type string

   Taille de l'exemplaire numérique

   url type string

   URL de l'exemplaire numérique, si applicable

   downloadUrl type string

   URL de téléchargement de l'exemplaire numérique

   vignUrl type string

   
   
   
   Sommaire

10. 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

11. 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

12. thesaurus

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

    thesaurus_id type integer

    thesaurus_caption type string

    thesaurus_num_root_node type integer

    thesaurus_num_unclassed_node type integer

    thesaurus_num_orphans_node type integer

    
    
    
    Sommaire

13. reading_list

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

    reading_list_id type integer

    reading_list_name type string

    reading_list_caption type string

    reading_list_emprid type integer

    reading_list_caption type string

    reading_list_confidential type boolean

    reading_list_public type boolean

    reading_list_readonly type boolean

    reading_list_notice_ids type tableau de integer

    
    
    
    Sommaire

14. collstate

    Nom du type:
    collstate
    Description:
    Décrit un état de collection
    Localisation:
    Importé du groupe pmbesTypes
    Contenu:

    collstate_id type integer

    Id de l'état de collection

    collstate_location_libelle type integer

    Libellé de l'état de collection

    collstate_cote type string

    Cote de l'état de collection

    collstate_type_libelle type string

    Libelle du support de l'état de collection

    collstate_emplacement_libelle type string

    Libellé de l'emplacement de l'état de collection

    collstate_statut_opac_libelle type string

    Libellé du statut OPAC de l'état de collection

    collstate_origine type string

    Origine de l'état de collection

    collstate_state_collections type string

    Statut de l'état de collection

    collstate_lacune type string

    Lacunes dans l'état de collection

    
    
    
    Sommaire

15. noticeAdministrative

    Nom du type:
    noticeAdministrative
    Description:
    Informations de gestion d'une notice
    Localisation:
    Importé du groupe pmbesTypes
    Contenu:

    statut_id type integer

    Id du statut

    statut_lib type string

    Libellé Opac du statut

    comment_admin type string

    Commentaire de gestion

    thumbnail_url type string

    URL de la vignette

    
    
    
    Sommaire

Méthodes

1. login

   Nom de la méthode:
   login
   Description:
   Vérifie l'authentification d'un lecteur et renvoie un numéro de session utilisable pour les autres fonctions
   Version:
   1.0
   Description des entrées:

   empr_login type string

   le login du lecteur

   empr_password type string

   le mot de passe du lecteur

   Description des retours:

   session_id type string

   le numéro de session. 0 si erreur.

   
   
   
   Sommaire

2. login_md5

   Nom de la méthode:
   login_md5
   Description:
   Vérifie l'authentification d'un lecteur et renvoie un numéro de session utilisable pour les autres fonctions
   Version:
   1.0
   Description des entrées:

   empr_login type string

   Le login du lecteur

   empr_password type string

   Le MD5 du mot de passe du lecteur

   Description des retours:

   session_id type string

   Le numéro de session. 0 si erreur.

   
   
   
   Sommaire

3. logout

   Nom de la méthode:
   logout
   Description:
   Invalide un numéro de session de la base
   Version:
   1.0
   Description des entrées:

   session_id type string

   le numéro de session

   Description des retours:

   rien

   
   
   
   Sommaire

4. list_locations

   Nom de la méthode:
   list_locations
   Description:
   Liste les différentes localisations de l'OPAC
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • list_locations du groupe pmbesOPACGeneric, en version 1.0
   Description des entrées:

   session_id type string

   Le numéro de session

   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

5. get_account_info

   Nom de la méthode:
   get_account_info
   Description:
   Retrouve les informations du compte du lecteur à partir du numéro de sa session
   Version:
   1.0
   Description des entrées:

   session_id type string

   le numéro de session

   Description des retours:

   result type reader id type integer        id de l'emprunteur cb type string        Code-barres personal_information type structure        Informations administratives de l'emprunteur firstname type string        Prénom lastname type string        Nom de famille address_part1 type string        Adresse (ligne 1) address_part2 type string        Adresse (ligne 2) address_cp type integer        Code postal address_city type string        Ville phone_number1 type string        Numéro de téléphone 1 phone_number2 type string        Numéro de téléphone 2 email type string        Email birthyear type integer        Année de naissance sex type integer        Sexe location_id type integer        Id de la localisation location_caption type string        Libellé de la localisation adhesion_date type string        Date de création de l'abonnement expiration_date type string        Date d'expiration de l'abonnement

   Une structure de type emprunteur

   
   
   
   Sommaire

6. change_password

   Nom de la méthode:
   change_password
   Description:
   Change le mot de passe de l'emprunteur associé à un numéro de session
   Version:
   1.0
   Description des entrées:

   session_id type string

   le numéro de session

   old_password type string

   l'ancien mot de passe

   new_password type string

   le nouveau mot de passe

   Description des retours:

   changed type boolean

   un booléen indiquant le succès éventuel de l'opération

   
   
   
   Sommaire

7. list_loans

   Nom de la méthode:
   list_loans
   Description:
   Retrouve les différents prêts d'un emprunteur associé à un numéro de session
   Version:
   1.0
   Description des entrées:

   session_id type string

   le numéro de session

   loan_type type integer

   le type des prêts que l'on souhaite récupérer: 0 (LIST_LOAN_ALL): tous les prêts 1 (LIST_LOAN_CURRENT): tous les prêts en cours 2 (LIST_LOAN_LATE): tous les prêts en retard

   Description des retours:

   loans type tableau de loan empr_id type integer        Id de l'emprunteur associé au prêt notice_id type integer        Id de la notice du document bulletin_id type integer        Id du bulletin si c'est un bulletin de périodique expl_id type integer        Id de l'exemplaire expl_cb type string        Code-barres de l'exemplaire expl_support type string        Support de l'exemplaire expl_location_id type integer        Id de la localisation de l'exemplaire expl_location_caption type string        Libellé de la localisation expl_section_id type integer        Id de la section de l'exemplaire expl_section_caption type string        Libellé de la section expl_libelle type string        Libellé de l'exemplaire loan_startdate type string        Date de prêt loan_returndate type string        Date de retour du prêt

   Les éventuels prêts

   
   
   
   Sommaire

8. list_resas

   Nom de la méthode:
   list_resas
   Description:
   Liste les réservations associées à un emprunteur à partir d'un numéro de session
   Version:
   1.0
   Description des entrées:

   session_id type string

   le numéro de session

   Description des retours:

   resas type tableau de resa resa_id type integer        Id de la réservation empr_id type integer        Id de l'emprunteur notice_id type integer        Id de la notice associée bulletin_id type integer        Id du bulletin associé resa_rank type integer        Rang de la réservation resa_dateend type string        Date de fin de validité de la réservation resa_retrait_location_id type integer        Id de la localisation de retrait de la réservation resa_retrait_location type string        Libellé de la localisation de retrait de la réservation

   Les différentes réservations, si elles existent

   
   
   
   Sommaire

9. delete_resa

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

   session_id type string

   resa_id type integer

   Description des retours:

   success type boolean

   
   
   
   Sommaire

10. add_review

    Nom de la méthode:
    add_review
    Description:
    Ajoute un avis sur une notice
    Version:
    1.0
    Description des entrées:

    session_id type string

    le numéro de session

    notice_id type integer

    l'id de la notice

    note type integer

    la note

    comment type string

    le commentaire

    subject type string

    le sujet

    Description des retours:

    success type boolean

    Un booléen indiquant le succès éventuel de l'opération

    
    
    
    Sommaire

11. add_tag

    Nom de la méthode:
    add_tag
    Description:
    Ajoute un tag sur une notice
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    notice_id type integer

    L'id de la notice

    tag type string

    Le tag

    Description des retours:

    success type boolean

    Un booléen indiquant le succès éventuel de l'opération

    
    
    
    Sommaire

12. list_suggestion_categories

    Nom de la méthode:
    list_suggestion_categories
    Description:
    Renvoie les différentes catégories disponibles pour les suggestions
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    Description des retours:

    categories type tableau de la structure suivante: category_id type integer        L'id de la catégorie category_caption type string        Le libellé de la catégorie

    Les différentes catégories

    
    
    
    Sommaire

13. list_suggestion_sources

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

    session_id type string

    Description des retours:

    sources type tableau de la structure suivante: source_id type integer         source_caption type string

    
    
    
    Sommaire

14. list_suggestion_sources_and_categories

    Nom de la méthode:
    list_suggestion_sources_and_categories
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • list_suggestion_sources du groupe pmbesOPACEmpr, en version 1.0
    • list_suggestion_categories du groupe pmbesOPACEmpr, en version 1.0
    Description des entrées:

    session_id type string

    Description des retours:

    sources type tableau de la structure suivante: source_id type integer         source_caption type string

    categories type tableau de la structure suivante: category_id type integer         category_caption type string

    
    
    
    Sommaire

15. add_suggestion

    Nom de la méthode:
    add_suggestion
    Description:
    Soumet une suggestion
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    title type string

    le titre

    author type string

    l'auteur

    editor type string

    l'éditeur

    isbn_or_ean type string

    l'isbn ou code-barres

    price type string

    le prix indicatif

    url type string

    le site internet associé

    comment type string

    le commentaire

    sugg_categ type integer

    la catégorie de la suggestion

    sugg_location type integer

    la localisation de la suggestion

    Description des retours:

    success type boolean

    Un booléen indiquant le succès éventuel de l'opération

    
    
    
    Sommaire

16. add_suggestion2

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

    session_id type string

    suggestion type suggestion sugg_id type string         sugg_date type string        Date de la suggestion sugg_title type string        Titre de l'oeuvre de la suggestion sugg_editor type string        Editeur de l'oeuvre de la suggestion sugg_author type string        Auteur de l'oeuvre de la suggestion sugg_barcode type string         sugg_price type string         sugg_url type string         sugg_comment type string         sugg_date type string         sugg_source type integer         sugg_source_caption type string         sugg_category type integer         sugg_category_caption type string         sugg_location type integer         sugg_state type string         sugg_state_caption type string        Statut de la suggestion

    Description des retours:

    success type boolean

    
    
    
    Sommaire

17. edit_suggestion

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

    session_id type string

    suggestion type suggestion sugg_id type string         sugg_date type string        Date de la suggestion sugg_title type string        Titre de l'oeuvre de la suggestion sugg_editor type string        Editeur de l'oeuvre de la suggestion sugg_author type string        Auteur de l'oeuvre de la suggestion sugg_barcode type string         sugg_price type string         sugg_url type string         sugg_comment type string         sugg_date type string         sugg_source type integer         sugg_source_caption type string         sugg_category type integer         sugg_category_caption type string         sugg_location type integer         sugg_state type string         sugg_state_caption type string        Statut de la suggestion

    Description des retours:

    success type boolean

    
    
    
    Sommaire

18. delete_suggestion

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

    session_id type string

    suggestion_id type integer

    Description des retours:

    success type boolean

    
    
    
    Sommaire

19. list_suggestions

    Nom de la méthode:
    list_suggestions
    Description:
    Liste les suggestions associées à un emprunteur à partir d'un numéro de session
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    Description des retours:

    suggs type tableau de suggestion sugg_id type string         sugg_date type string        Date de la suggestion sugg_title type string        Titre de l'oeuvre de la suggestion sugg_editor type string        Editeur de l'oeuvre de la suggestion sugg_author type string        Auteur de l'oeuvre de la suggestion sugg_barcode type string         sugg_price type string         sugg_url type string         sugg_comment type string         sugg_date type string         sugg_source type integer         sugg_source_caption type string         sugg_category type integer         sugg_category_caption type string         sugg_location type integer         sugg_state type string         sugg_state_caption type string        Statut de la suggestion

    Les différentes suggestions, si elles existent

    
    
    
    Sommaire

20. list_resa_locations

    Nom de la méthode:
    list_resa_locations
    Description:
    Renvoie les différentes localisations disponibles pour une réservation
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    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 localisations

    
    
    
    Sommaire

21. can_reserve_notice

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

    session_id type string

    notice_id type integer

    bulletin_id type integer

    Description des retours:

    can_reserve type boolean

    
    
    
    Sommaire

22. add_resa

    Nom de la méthode:
    add_resa
    Description:
    Ajoute une réservation pour une notice
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    notice_id type integer

    l'id de la notice

    bulletin_id type integer

    l'id du bulletin

    location type integer

    la localisation de retrait si applicable

    Description des retours:

    success type boolean

    Un booléen indiquant le succès éventuel de l'opération

    error type string

    Code d'erreur si la réservation n'est pas effectuée: no_session_id (pas de session) no_empr_id (pas d'id emprunteur) check_empr_exists (id emprunteur inconnu) check_notice_exists (Notice inconnue) check_quota (violation de quotas: Voir message complémentaire) check_resa_exists (Document déjà réservé par ce lecteur) check_allready_loaned (Document déjà emprunté par ce lecteur) check_statut (Pas de document prêtable) check_doc_dispo (Document disponible, mais non réservable) check_localisation_expl (Document non réservable dans les localisations autorisées) resa_no_create (échec de l'enregistrement de la résevation)

    message type string

    Message d'information complémentaire

    
    
    
    Sommaire

23. list_abonnements

    Nom de la méthode:
    list_abonnements
    Description:
    Liste les différents abonnements du lecteur
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    Description des retours:

    abonnements type tableau de abonnement abonnement_id type integer        Id de l'abonnement abonnement_type type string        Type de l'abonnement, PUBLIC ou PRIVATE abonnement_title type string        Titre de l'abonnement abonnement_lastsentdate type string        Date de dernier envoi abonnement_equation_human type string        Equation de recherche abonnement_notice_count type integer        Nombre de notices empr_subscriber type boolean        Précise si l'emprunteur est souscripteur de l'abonnement

    Les différents abonnements s'ils existent

    
    
    
    Sommaire

24. list_cart_content

    Nom de la méthode:
    list_cart_content
    Description:
    Liste le contenu du panier d'un emprunteur
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    Description des retours:

    cart_content type tableau de integer

    Les ids des notices du panier

    
    
    
    Sommaire

25. add_notices_to_cart

    Nom de la méthode:
    add_notices_to_cart
    Description:
    Ajoute des notices au panier d'un emprunteur
    Version:
    1.0
    Description des entrées:

    Les notices pour lesquelles l'emprunteur n'a pas les droits nécessaires ne seront pas ajoutées

    session_id type string

    Le numéro de session

    notice_ids type tableau de integer

    Les ids des notices à ajouter

    Description des retours:

    success type boolean

    Un booléen retournant le succès éventuel de l'opération

    
    
    
    Sommaire

26. delete_notices_from_cart

    Nom de la méthode:
    delete_notices_from_cart
    Description:
    Enlève des notices du panier d'un emprunteur
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    notice_ids type tableau de integer

    Les ids des notices à enlever

    Description des retours:

    success type boolean

    Un booléen retournant le succès éventuel de l'opération

    
    
    
    Sommaire

27. empty_cart

    Nom de la méthode:
    empty_cart
    Description:
    Vide le panier d'un emprunteur
    Version:
    1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    Description des retours:

    rien

    
    
    
    Sommaire

28. list_shelves

    Nom de la méthode:
    list_shelves
    Description:
    Liste les différentes étagères visibles dans l'opac
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • list_shelves du groupe pmbesOPACGeneric, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    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

29. 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
    Nécessite les méthodes suivantes:
    • retrieve_shelf_content du groupe pmbesOPACGeneric, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    shelf_id type integer

    L'id de l'étagère

    Description des retours:

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

    shelf_content type tableau de integer

    Les ids des notices

    
    
    
    Sommaire

30. simpleSearch

    Nom de la méthode:
    simpleSearch
    Description:
    Effectuer une recherche simple
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • simpleSearch du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    searchType type integer

    Le type de recherche: 0 (SEARCH_ALL)=tous les champs, 1 (SEARCH_TITLE)=titre, 2 (SEARCH_AUTHOR)=auteur, 3 (SEARCH_EDITOR)=éditeur, 4 (SEARCH_COLLECTION)=collection, 6 (SEARCH_CATEGORIES)=catégories/mots matières

    searchTerm type string

    Chaine à rechercher

    Description des retours:

    searchId type string

    Nom de la ressource résultat

    nbResults type integer

    Nombre de résultats

    typdocs type tableau de string

    
    
    
    Sommaire

31. getAdvancedSearchFields

    Nom de la méthode:
    getAdvancedSearchFields
    Description:
    Récupére la liste des champs recherchables en recherche avancée
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • getAdvancedSearchFields du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    fetch_values type boolean

    Précise s'il faut également chercher les valeurs des champs, pour un champ select par exemple

    Description des retours:

    results type tableau de search_field id type string        Id du champ de recherche label type string        Description du champ type type string        Type du champ operators type tableau de la structure suivante:        Opérateurs du champ id type string        Id de l'opération label type string        Affichage de l'opérateur values type tableau de la structure suivante:        Si fetch_values est à true et si le type du champ propose des valeurs prédéfinies: value_id type integer        Id de la valeur value_caption type string        Affichage de la valeur fieldvar type tableau de la structure suivante:        Si le champ contient des paramètres modifiables par l'utilisateur label type string        Description du paramètre name type string        Nom du paramètre type type string        Type du paramètre values type tableau de la structure suivante:        Si valeurs prédéfinies value_id type integer        Valeur value_caption type string        Libellé

    Les différents champs

    
    
    
    Sommaire

32. getAdvancedExternalSearchFields

    Nom de la méthode:
    getAdvancedExternalSearchFields
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • getAdvancedSearchFields du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    fetch_values type boolean

    Description des retours:

    results type tableau de search_field id type string        Id du champ de recherche label type string        Description du champ type type string        Type du champ operators type tableau de la structure suivante:        Opérateurs du champ id type string        Id de l'opération label type string        Affichage de l'opérateur values type tableau de la structure suivante:        Si fetch_values est à true et si le type du champ propose des valeurs prédéfinies: value_id type integer        Id de la valeur value_caption type string        Affichage de la valeur fieldvar type tableau de la structure suivante:        Si le champ contient des paramètres modifiables par l'utilisateur label type string        Description du paramètre name type string        Nom du paramètre type type string        Type du paramètre values type tableau de la structure suivante:        Si valeurs prédéfinies value_id type integer        Valeur value_caption type string        Libellé

    
    
    
    Sommaire

33. advancedSearch

    Nom de la méthode:
    advancedSearch
    Description:
    Effectuer une recherche avancée
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • advancedSearch du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    search type tableau de la structure suivante: inter type string        l'opérateur entre le champ et le champ précédent field type integer        l'id du champ de recherche operator type string        l'opérateur de recherche value type tableau de string

    La recherche

    Description des retours:

    searchId type string

    nom de la ressource résultat

    nbResults type integer

    nombre de résultats trouvés

    typdocs type tableau de string

    
    
    
    Sommaire

34. advancedSearchExternal

    Nom de la méthode:
    advancedSearchExternal
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • advancedSearch du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    search type tableau de la structure suivante: inter type string         field type integer         operator type string         value type tableau de string

    sourceIds type tableau de integer

    Description des retours:

    searchId type string

    nbResults type integer

    
    
    
    Sommaire

35. get_sort_types

    Nom de la méthode:
    get_sort_types
    Description:
    Renvoie la liste des différents tris possibles
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • get_sort_types du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Description des retours:

        Exemple de retour:
        Array
        (
        [0] => Array
        (
        [sort_name] => text_1
        [sort_caption] => Titre
        )
        
        [1] => Array
        (
        [sort_name] => num_2
        [sort_caption] => Indexation décimale
        )
        
        [2] => Array
        (
        [sort_name] => text_3
        [sort_caption] => Auteur
        )
      ...
    )

    results type tableau de la structure suivante: sort_name type string         sort_caption type string

    
    
    
    Sommaire

36. fetchSearchRecords

    Nom de la méthode:
    fetchSearchRecords
    Description:
    Fonctions pour récupérer les notices issues d'une recherche
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecords du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    searchId type string

    L'id renvoyé par la fonction de recherche

    firstRecord type integer

    Numéro de la première notice à récupérer

    recordCount type integer

    Nombre de notices à récupérer

    recordFormat type string

    Format des résultats

    recordCharset type string

    Charset dans lequel on souhaite les résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer        L'id de la notice noticeContent type string        La notice dans son format

    Les résultats

    
    
    
    Sommaire

37. fetchSearchRecordsSorted

    Nom de la méthode:
    fetchSearchRecordsSorted
    Description:
    Récupérer les notices issues d'une recherche, en appliquant un tri
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsSorted du groupe pmbesSearch, en version 1.0
    Description des entrées:

        Le paramètre sortType se construit de la façon suivante:
        typedutri_nomdutri, avec:
        -typedutri: d ou c pour un tri croissant ou décroissant
        -nomdutri: l'id du tri (voir la fonction get_sort_types).
        
        exemples:
        -c_text_1: tri par titre croissant.
        -d_num_7: tri par année d'édition décroissante.
        -c_text_5: tri par côte croissante.

    searchId type string

    l'id renvoyé par la fonction de recherche

    firstRecord type integer

    numéro de la première notice à récupérer

    recordCount type integer

    nombre de notices à récupérer

    recordFormat type string

    format des résultats

    recordCharset type string

    le charset dans lequel on souhaite les résultats

    sortType type string

    le tri à appliquer aux résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer        l'id de la notice noticeContent type string        la notice dans le format demandé

    Un tableau de résultats

    
    
    
    Sommaire

38. fetchSearchRecordsArray

    Nom de la méthode:
    fetchSearchRecordsArray
    Description:
    Fonctions pour récupérer les notices issues d'une recherche
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsArray du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    searchId type string

    L'id renvoyé par la fonction de recherche

    firstRecord type integer

    Numéro de la première notice à récupérer

    recordCount type integer

    Nombre de notices à récupérer

    recordCharset type string

    Charset dans lequel on souhaite les résultats

    Description des retours:

    results type tableau de unimarc_notice id type string        L'id de la notice header type tableau de la structure suivante:        L'entête unimarc name type string        Le nom du champ value type string        La valeur du champ f type tableau de la structure suivante:        Les champs f 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 résultats

    
    
    
    Sommaire

39. fetchSearchRecordsArraySorted

    Nom de la méthode:
    fetchSearchRecordsArraySorted
    Description:
    Récupérer les notices issues d'une recherche, en appliquant un tri
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsArraySorted du groupe pmbesSearch, en version 1.0
    Description des entrées:

        Le paramètre sortType se construit de la façon suivante:
        typedutri_nomdutri, avec:
        -typedutri: d ou c pour un tri croissant ou décroissant
        -nomdutri: l'id du tri (voir la fonction get_sort_types).
        
        exemples:
        -c_text_1: tri par titre croissant.
        -d_num_7: tri par année d'édition décroissante.
        -c_text_5: tri par côte croissante.

    searchId type string

    l'id renvoyé par la fonction de recherche

    firstRecord type integer

    numéro de la première notice à récupérer

    recordCount type integer

    nombre de notices à récupérer

    recordCharset type string

    le charset dans lequel on souhaite les résultats

    includeLinks type boolean

    inclure les liens entre notices, bulletins et articles

    includeItems type boolean

    inclure les exemplaires dans la zone 995

    sortType type string

    le tri à appliquer aux résultats

    Description des retours:

    results type tableau de unimarc_notice id type string        L'id de la notice header type tableau de la structure suivante:        L'entête unimarc name type string        Le nom du champ value type string        La valeur du champ f type tableau de la structure suivante:        Les champs f 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

    Un tableau de résultats

    
    
    
    Sommaire

40. fetch_notice_items

    Nom de la méthode:
    fetch_notice_items
    Description:
    Renvoie les différents exemplaires associés à une notice s'ils existent
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetch_notice_items du groupe pmbesItems, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    noticeid type integer

    L'id de la notice

    Description des retours:

    items type tableau de item id type integer        Id de l'exemplaire cb type string        Code-barres de l'exemplaire cote type string        Cote de l'exemplaire location_id type integer        Id de la localisation de l'exemplaire location_caption type string        Libellé de la localisation de l'exemplaire section_id type integer        Id de la section de l'exemplaire section_caption type string        Libellé de la section de l'exemplaire statut type string        Statut de l'exemplaire support type string        Support de l'exemplaire situation type string        Situation de l'exemplaire codestat type string

    Les exemplaires

    
    
    
    Sommaire

41. fetch_item

    Nom de la méthode:
    fetch_item
    Description:
    Renvoie un exemplaire par un de ses identifiants
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetch_item du groupe pmbesItems, en version 1.0
    Description des entrées:

    Au choix: item_cb ou item_id

    session_id type string

    item_cb type string

    Le code-barres de l'exemplaire

    item_id type integer

    L'id de l'exemplaire

    Description des retours:

    item type item id type integer        Id de l'exemplaire cb type string        Code-barres de l'exemplaire cote type string        Cote de l'exemplaire location_id type integer        Id de la localisation de l'exemplaire location_caption type string        Libellé de la localisation de l'exemplaire section_id type integer        Id de la section de l'exemplaire section_caption type string        Libellé de la section de l'exemplaire statut type string        Statut de l'exemplaire support type string        Support de l'exemplaire situation type string        Situation de l'exemplaire codestat type string

    L'exemplaire s'il existe

    
    
    
    Sommaire

42. listNoticeExplNums

    Nom de la méthode:
    listNoticeExplNums
    Description:
    Liste les documents numériques associés à une notice
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • listNoticeExplNums du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    noticeId type integer

    L'id de la notice concernée

    Description des retours:

    results type tableau de explNum id type integer        Id de l'exemplaire numérique noticeId type integer        Id de la notice associée à l'exemplaire numérique bulletinId type integer        Id du bulletin associé à l'exemplaire numérique name type string        Nom de l'exemplaire numérique mimetype type string        Mimetype de l'exemplaire numérique extention type string         filename type string        Nom du fichier de l'exemplaire numérique filesize type string        Taille de l'exemplaire numérique url type string        URL de l'exemplaire numérique, si applicable downloadUrl type string        URL de téléchargement de l'exemplaire numérique vignUrl type string

    Les documents numériques

    
    
    
    Sommaire

43. listBulletinExplNums

    Nom de la méthode:
    listBulletinExplNums
    Description:
    Liste les documents numériques associés à un bulletin
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • listBulletinExplNums du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    bulletinId type integer

    l'id du bulletin concerné

    Description des retours:

    results type tableau de explNum id type integer        Id de l'exemplaire numérique noticeId type integer        Id de la notice associée à l'exemplaire numérique bulletinId type integer        Id du bulletin associé à l'exemplaire numérique name type string        Nom de l'exemplaire numérique mimetype type string        Mimetype de l'exemplaire numérique extention type string         filename type string        Nom du fichier de l'exemplaire numérique filesize type string        Taille de l'exemplaire numérique url type string        URL de l'exemplaire numérique, si applicable downloadUrl type string        URL de téléchargement de l'exemplaire numérique vignUrl type string

    
    
    
    Sommaire

44. fetchNoticeList

    Nom de la méthode:
    fetchNoticeList
    Description:
    Récupère une liste de notices à partir de leurs ids, sous un format spécifié
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticeList du groupe pmbesNotices, en version 1.0
    Description des entrées:

    Attention, aux exigences des protocoles en matière de charset si vous utilisez cette fonction. Par exemple, si vous utilisez SOAP, vous devez transporter les notices en utf-8.

    session_id type string

    Le numéro de session

    noticelist type tableau de integer

    Les différentes notices (id)

    recordFormat type string

    le format dans lequel on souhaite ces notices

    recordCharset type string

    le charset dans lequel on souhaite les résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer        l'id de la notice noticeContent type string        la notice dans le format demandé

    Les différentes notices

    
    
    
    Sommaire

45. fetchNoticeListFull

    Nom de la méthode:
    fetchNoticeListFull
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticeListFull du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    noticelist type tableau de integer

    recordFormat type string

    recordCharset type string

    includeLinks type boolean

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletins type tableau de bulletin noticeCollstates type tableau de collstate noticeAdministrative type tableau de noticeAdministrative

    
    
    
    Sommaire

46. fetchExternalNoticeList

    Nom de la méthode:
    fetchExternalNoticeList
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchExternalNoticeList du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    noticelist type tableau de integer

    recordFormat type string

    recordCharset type string

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string

    
    
    
    Sommaire

47. findNoticeBulletinId

    Nom de la méthode:
    findNoticeBulletinId
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • findNoticeBulletinId du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    noticeId type integer

    Description des retours:

    bulletinId type integer

    
    
    
    Sommaire

48. simpleSearchLocalise

    Nom de la méthode:
    simpleSearchLocalise
    Description:
    Effectuer une recherche simple filtrée par localisation et section
    Version:
    1.0
    Description des entrées:

    searchType type integer

    Le type de la recherche: 0 (SEARCH_ALL)=tous les champs, 1 (SEARCH_TITLE)=titre, 2 (SEARCH_AUTHOR)=auteur, 3 (SEARCH_EDITOR)=éditeur, 4 (SEARCH_COLLECTION)=collection, 6 (SEARCH_CATEGORIES)=catégories/mots matières

    searchTerm type string

    chaine à rechercher

    pmbUserId type integer

    l'id d'un utilisateur pmb, pour filtrer les résultats selon les droits d'accès. -1: pour ne pas en tenir compte

    OPACUserId type integer

    l'id d'un emprunteur, pour filtrer les résultats selon les droits d'accès -1: Ne pas tenir compte 0: emprunteur anonyme x: id de l'emprunteur

    localisation type integer

    section type integer

    Description des retours:

    searchId type string

    nom de la ressource résultat

    nbResults type integer

    nombre de résultats trouvés

    typdocs type tableau de string

    
    
    
    Sommaire

49. fetchNoticeByExplCb

    Nom de la méthode:
    fetchNoticeByExplCb
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticeByExplCb du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    explCb type string

    recordFormat type string

    recordCharset type string

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string

    
    
    
    Sommaire

50. self_checkout

    Nom de la méthode:
    self_checkout
    Description:
    Permet de faire le prêt d'un document
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • self_checkout du groupe pmbesSelfServices, en version 1.0
    Description des entrées:

    session_id type string

    expl_cb type string

    Le code-barres du document

    Description des retours:

    status type boolean

    1: Le prêt du document est accepté. 0: Le prêt du document est refusé

    message type string

    Message du prêt

    title type string

    Titre du document

    transaction_date type string

    Date du prêt

    due_date type string

    Date de retour

    message_quota type string

    Message de quotas

    
    
    
    Sommaire

51. self_checkin

    Nom de la méthode:
    self_checkin
    Description:
    Permet de faire le retour d'un document
    Version:
    1.0
    Description des entrées:

    expl_cb type string

    Le code-barres du document

    pmbUserId type integer

    l'id d'un utilisateur pmb, pour effectuer les actions de réservation ou de transfert en fonction de la localisation.

    Description des retours:

    status type boolean

    1: Le retour du document est accepté. 0: Le retour du document est refusé

    message type string

    Message du retour de prêt

    title type string

    Titre du document

    transaction_date type string

    Date du retour

    message_loc type string

    Message concernant la localisation du document

    message_resa type string

    Message concernant la réservation du document

    message_retard type string

    Message si retard sur le retour du document

    message_amende type string

    Message si l'emprunteur à une amende

    
    
    
    Sommaire

52. self_renew

    Nom de la méthode:
    self_renew
    Description:
    Permet de faire la prolongation de prêt d'un document
    Version:
    1.0
    Description des entrées:

    expl_cb type string

    Le code-barres du document

    pmbUserId type integer

    l'id d'un utilisateur pmb, pour effectuer la prolongation de prêt en fonction de la localisation.

    Description des retours:

    status type boolean

    1: La prolongation du prêt est acceptée. 0: La prolongation du prêt est refusée

    message type string

    Message de la prolongation du prêt

    title type string

    Titre du document

    transaction_date type string

    Date de la prolongation

    due_date type string

    Date de retour

    
    
    
    Sommaire

53. get_author_information_and_notices

    Nom de la méthode:
    get_author_information_and_notices
    Description:
    Combine les fonctions get_author_information et list_author_notices du groupe pmbesAuthors
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • get_author_information_and_notices du groupe pmbesAuthors, en version 1.0
    Description des entrées:

    Voir les entrées des fonctions combinées

    session_id type string

    author_id type integer

    Description des retours:

    Voir les sorties des fonctions combinées

    information type author

    notice_ids type tableau de integer

    
    
    
    Sommaire

54. get_collection_information_and_notices

    Nom de la méthode:
    get_collection_information_and_notices
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • get_collection_information_and_notices du groupe pmbesCollections, en version 1.0
    Description des entrées:

    session_id type string

    collection_id type integer

    Description des retours:

    information type collection

    notice_ids type tableau de integer

    
    
    
    Sommaire

55. get_subcollection_information_and_notices

    Nom de la méthode:
    get_subcollection_information_and_notices
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • get_subcollection_information_and_notices du groupe pmbesCollections, en version 1.0
    Description des entrées:

    session_id type string

    subcollection_id type integer

    Description des retours:

    information type sous_collection

    notice_ids type tableau de integer

    
    
    
    Sommaire

56. get_publisher_information_and_notices

    Nom de la méthode:
    get_publisher_information_and_notices
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • get_publisher_information_and_notices du groupe pmbesPublishers, en version 1.0
    Description des entrées:

    session_id type string

    publisher_id type integer

    Description des retours:

    information type publisher

    notice_ids type tableau de integer

    
    
    
    Sommaire

57. list_thesauri

    Nom de la méthode:
    list_thesauri
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • list_thesauri du groupe pmbesThesauri, en version 1.0
    Description des entrées:

    session_id type string

    Description des retours:

    thesauri type tableau de thesaurus thesaurus_id type integer         thesaurus_caption type string         thesaurus_num_root_node type integer         thesaurus_num_unclassed_node type integer         thesaurus_num_orphans_node type integer

    
    
    
    Sommaire

58. fetch_thesaurus_node_full

    Nom de la méthode:
    fetch_thesaurus_node_full
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetch_node_full du groupe pmbesThesauri, en version 1.0
    Description des entrées:

    session_id type string

    node_id type integer

    Description des retours:

    node type node

    notice_ids type tableau de integer

    
    
    
    Sommaire

59. fetchNoticesCollstates

    Nom de la méthode:
    fetchNoticesCollstates
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticesCollstates du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    serial_ids type tableau de integer

    Description des retours:

    collstates type tableau de collstate collstate_id type integer        Id de l'état de collection collstate_location_libelle type integer        Libellé de l'état de collection collstate_cote type string        Cote de l'état de collection collstate_type_libelle type string        Libelle du support de l'état de collection collstate_emplacement_libelle type string        Libellé de l'emplacement de l'état de collection collstate_statut_opac_libelle type string        Libellé du statut OPAC de l'état de collection collstate_origine type string        Origine de l'état de collection collstate_state_collections type string        Statut de l'état de collection collstate_lacune type string        Lacunes dans l'état de collection

    
    
    
    Sommaire

60. fetch_notices_bulletins

    Nom de la méthode:
    fetch_notices_bulletins
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetch_notices_bulletins du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    noticesid type

    Description des retours:

    result type tableau de la structure suivante: noticeid type integer         bulletins type tableau de bulletin

    
    
    
    Sommaire

61. fetchSerialList

    Nom de la méthode:
    fetchSerialList
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSerialList du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    Description des retours:

    result type tableau de serial

    
    
    
    Sommaire

62. listExternalSources

    Nom de la méthode:
    listExternalSources
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • listExternalSources du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Description des retours:

    results type tableau de la structure suivante: category_caption type string         sources type tableau de la structure suivante:         source_id type string         source_caption type string         source_comment type string

    
    
    
    Sommaire

63. fetchNoticeListFullWithBullId

    Nom de la méthode:
    fetchNoticeListFullWithBullId
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticeListFullWithBullId du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    noticelist type tableau de integer

    recordFormat type string

    recordCharset type string

    includeLinks type boolean

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletinIds type tableau de integer noticeCollstates type tableau de collstate noticeAdministrative type tableau de noticeAdministrative

    
    
    
    Sommaire

64. fetchNoticesBulletinsList

    Nom de la méthode:
    fetchNoticesBulletinsList
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticesBulletinsList du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    noticelist type tableau de integer

    Description des retours:

    bulletinIds type tableau de integer

    
    
    
    Sommaire

65. fetchSearchRecordsFull

    Nom de la méthode:
    fetchSearchRecordsFull
    Description:
    Fonctions pour récupérer les notices issues d'une recherche
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsFull du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    searchId type string

    L'id renvoyé par la fonction de recherche

    firstRecord type integer

    Numéro de la première notice à récupérer

    recordCount type integer

    Nombre de notices à récupérer

    recordCharset type string

    Charset dans lequel on souhaite les résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletins type tableau de bulletin noticeCollstates type tableau de collstate

    
    
    
    Sommaire

66. fetchSearchRecordsFullSorted

    Nom de la méthode:
    fetchSearchRecordsFullSorted
    Description:
    Récupérer les notices issues d'une recherche, en appliquant un tri
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsFullSorted du groupe pmbesSearch, en version 1.0
    Description des entrées:

        Le paramètre sortType se construit de la façon suivante:
        typedutri_nomdutri, avec:
        -typedutri: d ou c pour un tri croissant ou décroissant
        -nomdutri: l'id du tri (voir la fonction get_sort_types).
        
        exemples:
        -c_text_1: tri par titre croissant.
        -d_num_7: tri par année d'édition décroissante.
        -c_text_5: tri par côte croissante.

    session_id type string

    Le numéro de session

    searchId type string

    l'id renvoyé par la fonction de recherche

    firstRecord type integer

    numéro de la première notice à récupérer

    recordCount type integer

    nombre de notices à récupérer

    recordCharset type string

    le charset dans lequel on souhaite les résultats

    sortType type string

    le tri à appliquer aux résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletins type tableau de bulletin noticeCollstates type tableau de collstate

    
    
    
    Sommaire

67. fetchSearchRecordsFullWithBullId

    Nom de la méthode:
    fetchSearchRecordsFullWithBullId
    Description:
    Fonctions pour récupérer les notices issues d'une recherche
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsFullWithBullId du groupe pmbesSearch, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    searchId type string

    L'id renvoyé par la fonction de recherche

    firstRecord type integer

    Numéro de la première notice à récupérer

    recordCount type integer

    Nombre de notices à récupérer

    recordCharset type string

    Charset dans lequel on souhaite les résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletinIds type tableau de integer noticeCollstates type tableau de collstate

    
    
    
    Sommaire

68. fetchSearchRecordsFullWithBullIdSorted

    Nom de la méthode:
    fetchSearchRecordsFullWithBullIdSorted
    Description:
    Récupérer les notices issues d'une recherche, en appliquant un tri
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsFullWithBullIdSorted du groupe pmbesSearch, en version 1.0
    Description des entrées:

        Le paramètre sortType se construit de la façon suivante:
        typedutri_nomdutri, avec:
        -typedutri: d ou c pour un tri croissant ou décroissant
        -nomdutri: l'id du tri (voir la fonction get_sort_types).
        
        exemples:
        -c_text_1: tri par titre croissant.
        -d_num_7: tri par année d'édition décroissante.
        -c_text_5: tri par côte croissante.

    session_id type string

    Le numéro de session

    searchId type string

    l'id renvoyé par la fonction de recherche

    firstRecord type integer

    numéro de la première notice à récupérer

    recordCount type integer

    nombre de notices à récupérer

    recordCharset type string

    le charset dans lequel on souhaite les résultats

    sortType type string

    le tri à appliquer aux résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletinIds type tableau de integer noticeCollstates type tableau de collstate

    
    
    
    Sommaire

69. fetchBulletinListFull

    Nom de la méthode:
    fetchBulletinListFull
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchBulletinListFull du groupe pmbesNotices, en version 1.0
    Description des entrées:

    session_id type string

    Le numéro de session

    bulletinlist type tableau de integer

    recordFormat type string

    recordCharset type string

    Description des retours:

    results type tableau de la structure suivante: bulletin_id type integer         bulletin_bulletin type bulletin         bulletin_notice type string         bulletin_items type tableau de item bulletin_doc_nums type tableau de explNum bulletin_analysis_notice_ids type tableau de integer

    
    
    
    Sommaire

70. getReadingLists

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

    session_id type string

    Description des retours:

    results type tableau de reading_list reading_list_id type integer         reading_list_name type string         reading_list_caption type string         reading_list_emprid type integer         reading_list_caption type string         reading_list_confidential type boolean         reading_list_public type boolean         reading_list_readonly type boolean         reading_list_notice_ids type tableau de integer

    
    
    
    Sommaire

71. getPublicReadingLists

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

    session_id type string

    Description des retours:

    results type tableau de reading_list reading_list_id type integer         reading_list_name type string         reading_list_caption type string         reading_list_emprid type integer         reading_list_caption type string         reading_list_confidential type boolean         reading_list_public type boolean         reading_list_readonly type boolean         reading_list_notice_ids type tableau de integer

    
    
    
    Sommaire

72. addNoticesToReadingList

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

    session_id type string

    list_id type integer

    notice_ids type tableau de integer

    Description des retours:

    
    
    
    Sommaire

73. removeNoticesFromReadingList

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

    session_id type string

    list_id type integer

    notice_ids type tableau de integer

    Description des retours:

    
    
    
    Sommaire

74. emptyReadingList

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

    session_id type string

    list_id type integer

    Description des retours:

    
    
    
    Sommaire

75. listFacets

    Nom de la méthode:
    listFacets
    Description:
    Récupérer les facettes issues d'une recherche
    Version:
    1.0
    Description des entrées:

    session_id type string

    searchId type string

    l'id renvoyé par la fonction de recherche

    fields type tableau de la structure suivante: code_champ type integer        Code champ code_ss_champ type integer        Code sous champ

    Un tableau de facettes à calculer

    filters type tableau de la structure suivante: code_champ type integer        Code champ code_ss_champ type integer        Code sous champ value type string        Valeur

    Un tableau de filtres (affinage : facettes déjà sélectionnées)

    Description des retours:

    results type tableau de la structure suivante: code_champ type integer        Code champ code_ss_champ type integer        Code sous champ value type string         count type integer        Nombre de notices associées

    Liste des facettes calculées

    
    
    
    Sommaire

76. listRecordsFromFacets

    Nom de la méthode:
    listRecordsFromFacets
    Description:
    Récupérer les notices issues d'une ou plusieurs facettes
    Version:
    1.0
    Description des entrées:

    session_id type string

    searchId type string

    l'id renvoyé par la fonction de recherche

    filters type tableau de la structure suivante: code_champ type integer        Code champ code_ss_champ type integer        Code sous champ value type string        Valeur

    Un tableau de filtres (affinage : facettes déjà sélectionnées)

    Description des retours:

    results type tableau de integer

    Liste des notices

    
    
    
    Sommaire