API PMB: Groupe pmbesNotices

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

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

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

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

4. bulletin

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

   bulletin_id type integer

   Id du bulletin

   serial_id type integer

   Id de la notice de périodique associée au bulletin

   serial_title type string

   Titre de la notice de périodique associée au bulletin

   notice_id type integer

   Id de la notice du bulletin

   bulletin_number type string

   Numéro du bulletin

   bulletin_date_caption type string

   Libellé de la date du bulletin

   bulletin_date type string

   Date de parution du bulletin

   bulletin_title type string

   Titre du bulletin

   bulletin_barcode type string

   Code-barres du bulletin

   
   
   
   Sommaire

5. serial

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

   serial_id type integer

   serial_title type string

   serial_issues_count type integer

   serial_items_count type integer

   serial_analysis_count type integer

   
   
   
   Sommaire

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

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

   Nom de la méthode:
   fetchNoticeList
   Description:
   Récupère une liste de notices à partir de leurs ids, sous un format spécifique
   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.

   noticelist type tableau de integer

   un tableau contenant la liste des id des notices que l'on souhaite récupérer

   recordFormat type string

   le format dans lequel on souhaite ces notices

   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

   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

2. fetchExternalNoticeList

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

   noticelist type tableau de integer

   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         noticeContent type string

   
   
   
   Sommaire

3. fetchNoticeListArray

   Nom de la méthode:
   fetchNoticeListArray
   Description:
   Se comporte comme la fonction fetchNoticeList, sauf que les notices ne sont pas converties dans un format spécifique, mais sont envoyées directement sous la forme d'un tableau unimarc
   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.

   noticelist type tableau de integer

   un tableau contenant la liste des id des notices que l'on souhaite 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

   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 différentes notices

   
   
   
   Sommaire

4. listNoticeExplNums

   Nom de la méthode:
   listNoticeExplNums
   Description:
   Liste les documents numériques associés à une notice
   Version:
   1.0
   Description des entrées:

   noticeId type integer

   l'id de la notice concernée

   OPACUserId type integer

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

   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

   des informations sur les documents numériques s'ils existent

   
   
   
   Sommaire

5. listNoticesExplNums

   Nom de la méthode:
   listNoticesExplNums
   Description:
   Fait la même chose que listNoticeExplNums mais pour plusieurs notices à la fois
   Version:
   1.0
   Description des entrées:

   noticesid type

   Un tableau contenant les ids des notices

   OPACUserId type integer

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

   Description des retours:

   result type tableau de la structure suivante: noticeid type integer        L'id de la notice explnums type tableau de explNum

   Les résultats

   
   
   
   Sommaire

6. listBulletinExplNums

   Nom de la méthode:
   listBulletinExplNums
   Description:
   Liste les documents numériques associés à un bulletin
   Version:
   1.0
   Description des entrées:

   bulletinId type integer

   l'id du bulletin concerné

   OPACUserId type integer

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

   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

   des informations sur les documents numériques s'ils existent

   
   
   
   Sommaire

7. listBulletinsExplNums

   Nom de la méthode:
   listBulletinsExplNums
   Description:
   Fait la même chose que listBulletinsExplNums mais pour plusieurs bulletins à la fois
   Version:
   1.0
   Description des entrées:

   bulletin_ids type

   Un tableau contenant les ids des bulletins

   OPACUserId type integer

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

   Description des retours:

   results type tableau de la structure suivante: bulletin_id type integer        L'id du bulletin bulletin_explnums type tableau de explNum

   Les résultats

   
   
   
   Sommaire

8. fetchNoticeByExplCb

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

   emprId type string

   explCb type string

   recordFormat type string

   recordCharset type string

   includeLinks type boolean

   includeItems type boolean

   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é noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletins type tableau de bulletin collstates type tableau de collstate

   Les résultats

   
   
   
   Sommaire

9. fetch_notices_bulletins

   Nom de la méthode:
   fetch_notices_bulletins
   Description:
   Retourne les bulletins associés à des notices de périodique
   Version:
   1.0
   Description des entrées:

   noticesid type

   Un tableau contenant les ids des notices

   OPACUserId type integer

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

   Description des retours:

   result type tableau de la structure suivante: noticeid type integer        L'id de la notice bulletins type tableau de bulletin

   Les résultats

   
   
   
   Sommaire

10. fetchNoticeListFull

    Nom de la méthode:
    fetchNoticeListFull
    Description:
    Renvoie le plus d'informations possible sur une série de notices
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticeList du groupe pmbesNotices, en version 1.0
    • listNoticesExplNums du groupe pmbesNotices, en version 1.0
    • fetch_notices_bulletins du groupe pmbesNotices, en version 1.0
    • fetchNoticesCollstates du groupe pmbesNotices, en version 1.0
    • fetchNoticesAdministrative du groupe pmbesNotices, en version 1.0
    • fetch_notices_items du groupe pmbesItems, en version 1.0
    Description des entrées:

    noticelist type tableau de integer

    Un tableau contenant les ids des notices que l'on souhaite retrouver

    recordFormat type string

    Le format dans lequel on veut retrouver la notice

    recordCharset type string

    Le charset du format. Mettre utf-8 si c'est pour utiliser à travers un connecteur

    includeLinks type boolean

    Inclure les liens entre notices

    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é 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

    Les résultats

    
    
    
    Sommaire

11. fetch_bulletin_list

    Nom de la méthode:
    fetch_bulletin_list
    Description:
    Renvoie une liste de bulletins
    Version:
    1.0
    Description des entrées:

    bulletin_ids type

    Les ids des bulletins

    Description des retours:

    result type tableau de bulletin bulletin_id type integer        Id du bulletin serial_id type integer        Id de la notice de périodique associée au bulletin serial_title type string        Titre de la notice de périodique associée au bulletin notice_id type integer        Id de la notice du bulletin bulletin_number type string        Numéro du bulletin bulletin_date_caption type string        Libellé de la date du bulletin bulletin_date type string        Date de parution du bulletin bulletin_title type string        Titre du bulletin bulletin_barcode type string        Code-barres du bulletin

    Les bulletins

    
    
    
    Sommaire

12. findNoticeBulletinId

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

    noticeId type

    Description des retours:

    bulletinId type integer

    
    
    
    Sommaire

13. fetchBulletinListFull

    Nom de la méthode:
    fetchBulletinListFull
    Description:
    Renvoie le plus d'informations sur une série de bulletins
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetch_bulletin_list du groupe pmbesNotices, en version 1.0
    • listBulletinsExplNums du groupe pmbesNotices, en version 1.0
    • fetchNoticeList du groupe pmbesNotices, en version 1.0
    • fetch_bulletins_items du groupe pmbesItems, en version 1.0
    Description des entrées:

    bulletinlist type tableau de integer

    Les ids des bulletins à récupérer

    recordFormat type string

    Le format dans lequel on veut la notice du bulletin (si elle existe)

    recordCharset type string

    Le charset du format. Mettre utf-8 si c'est pour utiliser à travers un connecteur

    Description des retours:

    results type tableau de la structure suivante: bulletin_id type integer        L'id du bulletin bulletin_bulletin type true bulletin_id type integer        Id du bulletin serial_id type integer        Id de la notice de périodique associée au bulletin serial_title type string        Titre de la notice de périodique associée au bulletin notice_id type integer        Id de la notice du bulletin bulletin_number type string        Numéro du bulletin bulletin_date_caption type string        Libellé de la date du bulletin bulletin_date type string        Date de parution du bulletin bulletin_title type string        Titre du bulletin bulletin_barcode type string        Code-barres du bulletin bulletin_notice type string        La notice associée au bulletin, si elle existe bulletin_items type tableau de item bulletin_doc_nums type tableau de explNum bulletin_analysis_notice_ids type tableau de integer

    Les résultats

    
    
    
    Sommaire

14. fetchNoticesCollstates

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

    serial_ids type tableau de integer

    OPACUserId type 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

15. fetchSerialList

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

    OPACUserId type integer

    Description des retours:

    result type tableau de serial serial_id type integer         serial_title type string         serial_issues_count type integer         serial_items_count type integer         serial_analysis_count type integer

    
    
    
    Sommaire

16. fetchNoticeListFullWithBullId

    Nom de la méthode:
    fetchNoticeListFullWithBullId
    Description:
    Renvoie le plus d'informations possible sur une série de notices
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticeList du groupe pmbesNotices, en version 1.0
    • listNoticesExplNums du groupe pmbesNotices, en version 1.0
    • fetchNoticesBulletinsList du groupe pmbesNotices, en version 1.0
    • fetchNoticesCollstates du groupe pmbesNotices, en version 1.0
    • fetchNoticesAdministrative du groupe pmbesNotices, en version 1.0
    • fetch_notices_items du groupe pmbesItems, en version 1.0
    Description des entrées:

    noticelist type tableau de integer

    Un tableau contenant les ids des notices que l'on souhaite retrouver

    recordFormat type string

    Le format dans lequel on veut retrouver la notice

    recordCharset type string

    Le charset du format. Mettre utf-8 si c'est pour utiliser à travers un connecteur

    includeLinks type boolean

    Inclure les liens entre notices

    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é noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletinIds type tableau de integer collstates type tableau de collstate noticeAdministrative type tableau de noticeAdministrative

    Les résultats

    
    
    
    Sommaire

17. fetchNoticesBulletinsList

    Nom de la méthode:
    fetchNoticesBulletinsList
    Description:
    Renvoie une liste de bulletins
    Version:
    1.0
    Description des entrées:

    noticelist type tableau de integer

    Un tableau contenant les ids des notices que l'on souhaite retrouver

    Description des retours:

    bulletinIds type tableau de integer

    Les bulletins

    
    
    
    Sommaire

18. fetchNoticesAdministrative

    Nom de la méthode:
    fetchNoticesAdministrative
    Description:
    Renvoie les informations de gestion d'une notice
    Version:
    1.0
    Description des entrées:

    noticelist type tableau de integer

    Un tableau contenant les ids des notices que l'on souhaite retrouver

    Description des retours:

    notiesAdministrative type tableau de la structure suivante: noticeId type integer        L'id de la notice administrative type true 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

    Les informations de gestion de la notice

    
    
    
    Sommaire

19. deleteNotices

    Nom de la méthode:
    deleteNotices
    Description:
    Supprime la liste des notices
    Version:
    1.0
    Description des entrées:

    tab_notice type tableau de integer

    forcage type boolean

    Description des retours:

    states type tableau de la structure suivante: noticeId type integer        Identifiant de la notice state type string        Etat de la suppression : 0->Ok, 1->Droits insuffisants, 2->Echec de la suppression

    
    
    
    Sommaire

20. checkdelnotice

    Nom de la méthode:
    checkdelnotice
    Description:
    On vérifie que la notice peut être supprimer
    Version:
    1.0
    Description des entrées:

    notice_id type integer

    Description des retours:

    retour type boolean

    
    
    
    Sommaire