API PMB: Groupe pmbesCollections

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

1. collection

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

   collection_id type integer

   Id de la collection

   collection_name type string

   Nom de la collection

   collection_parent type integer

   Id de l'éditeur de la collection

   collection_issn type string

   ISSN de la collection

   collection_web type string

   Site web de la collection

   collection_links type links autlink_to type string        Type de l'autorité liée: 1 -> Auteur, 2 -> Catégorie, 3 -> Editeur, 4 -> Collection, 5 -> Sous-collection, 6 -> Titre de série, 7 -> Titre uniforme, 8 -> Indexation autlink_to_id type integer        Id de l'autorité liée autlink_to_libelle type string        Libellé de l'autorité liée autlink_type type integer        Code du type de lien autlink_reciproc type boolean        Le lien est-il réciproque (0 ou 1) ? autlink_comment type string        Commentaire associé au lien

   
   
   
   Sommaire

2. sous_collection

   Nom du type:
   sous_collection
   Description:
   Décrit une sous-collection
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   sous_collection_id type integer

   Id de la sous-collection

   sous_collection_name type string

   Nom de la sous collection

   sous_collection_parent type integer

   Id de la collection associée

   sous_collection_issn type string

   ISSN de la sous-collection

   sous_collection_web type string

   Site web de la sous-collection

   collection_links type links autlink_to type string        Type de l'autorité liée: 1 -> Auteur, 2 -> Catégorie, 3 -> Editeur, 4 -> Collection, 5 -> Sous-collection, 6 -> Titre de série, 7 -> Titre uniforme, 8 -> Indexation autlink_to_id type integer        Id de l'autorité liée autlink_to_libelle type string        Libellé de l'autorité liée autlink_type type integer        Code du type de lien autlink_reciproc type boolean        Le lien est-il réciproque (0 ou 1) ? autlink_comment type string        Commentaire associé au lien

   
   
   
   Sommaire

Méthodes

1. get_collection_information

   Nom de la méthode:
   get_collection_information
   Description:
   Renvoie les informations d'une collection
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • getLinks du groupe pmbesAutLinks, en version 1.0
   Description des entrées:

   collection_id type integer

   L'id de la collection

   Description des retours:

   result type collection collection_id type integer        Id de la collection collection_name type string        Nom de la collection collection_parent type integer        Id de l'éditeur de la collection collection_issn type string        ISSN de la collection collection_web type string        Site web de la collection collection_links type autlink_to type string        Type de l'autorité liée: 1 -> Auteur, 2 -> Catégorie, 3 -> Editeur, 4 -> Collection, 5 -> Sous-collection, 6 -> Titre de série, 7 -> Titre uniforme, 8 -> Indexation autlink_to_id type integer        Id de l'autorité liée autlink_to_libelle type string        Libellé de l'autorité liée autlink_type type integer        Code du type de lien autlink_reciproc type boolean        Le lien est-il réciproque (0 ou 1) ? autlink_comment type string        Commentaire associé au lien

   Les informations

   
   
   
   Sommaire

2. get_subcollection_information

   Nom de la méthode:
   get_subcollection_information
   Description:
   Renvoie les informations d'une sous collection
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • getLinks du groupe pmbesAutLinks, en version 1.0
   Description des entrées:

   subcollection_id type integer

   L'id de la sous collection

   Description des retours:

   result type sous_collection sous_collection_id type integer        Id de la sous-collection sous_collection_name type string        Nom de la sous collection sous_collection_parent type integer        Id de la collection associée sous_collection_issn type string        ISSN de la sous-collection sous_collection_web type string        Site web de la sous-collection collection_links type autlink_to type string        Type de l'autorité liée: 1 -> Auteur, 2 -> Catégorie, 3 -> Editeur, 4 -> Collection, 5 -> Sous-collection, 6 -> Titre de série, 7 -> Titre uniforme, 8 -> Indexation autlink_to_id type integer        Id de l'autorité liée autlink_to_libelle type string        Libellé de l'autorité liée autlink_type type integer        Code du type de lien autlink_reciproc type boolean        Le lien est-il réciproque (0 ou 1) ? autlink_comment type string        Commentaire associé au lien

   Les informations

   
   
   
   Sommaire

3. list_collection_notices

   Nom de la méthode:
   list_collection_notices
   Description:
   Renvoie les ids des notices appartenant à une collection
   Version:
   1.0
   Description des entrées:

   collection_id type integer

   L'id de la collection

   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

   Description des retours:

   notice_ids type tableau de integer

   Les ids des notices

   
   
   
   Sommaire

4. list_collection_subcollections

   Nom de la méthode:
   list_collection_subcollections
   Description:
   Liste les sous collections contenues dans une collection
   Version:
   1.0
   Description des entrées:

   collection_id type integer

   L'id de la collection

   Description des retours:

   sub_collections type tableau de sous_collection sous_collection_id type integer        Id de la sous-collection sous_collection_name type string        Nom de la sous collection sous_collection_parent type integer        Id de la collection associée sous_collection_issn type string        ISSN de la sous-collection sous_collection_web type string        Site web de la sous-collection collection_links type autlink_to type string        Type de l'autorité liée: 1 -> Auteur, 2 -> Catégorie, 3 -> Editeur, 4 -> Collection, 5 -> Sous-collection, 6 -> Titre de série, 7 -> Titre uniforme, 8 -> Indexation autlink_to_id type integer        Id de l'autorité liée autlink_to_libelle type string        Libellé de l'autorité liée autlink_type type integer        Code du type de lien autlink_reciproc type boolean        Le lien est-il réciproque (0 ou 1) ? autlink_comment type string        Commentaire associé au lien

   Les sous collections

   
   
   
   Sommaire

5. list_subcollection_notices

   Nom de la méthode:
   list_subcollection_notices
   Description:
   Renvoie les ids des notices appartenant à une sous-collection
   Version:
   1.0
   Description des entrées:

   subcollection_id type integer

   L'id de la sous collection

   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

   Description des retours:

   notice_ids type tableau de integer

   Les ids des notices

   
   
   
   Sommaire

6. get_collection_information_and_notices

   Nom de la méthode:
   get_collection_information_and_notices
   Description:
   Combine les fonctions get_collection_information et list_collection_notices
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • get_collection_information du groupe pmbesCollections, en version 1.0
   • list_collection_notices du groupe pmbesCollections, en version 1.0
   • getLinks du groupe pmbesAutLinks, en version 1.0
   Description des entrées:

   collection_id type integer

   OPACUserId type integer

   Description des retours:

   information type collection collection_id type integer        Id de la collection collection_name type string        Nom de la collection collection_parent type integer        Id de l'éditeur de la collection collection_issn type string        ISSN de la collection collection_web type string        Site web de la collection collection_links type autlink_to type string        Type de l'autorité liée: 1 -> Auteur, 2 -> Catégorie, 3 -> Editeur, 4 -> Collection, 5 -> Sous-collection, 6 -> Titre de série, 7 -> Titre uniforme, 8 -> Indexation autlink_to_id type integer        Id de l'autorité liée autlink_to_libelle type string        Libellé de l'autorité liée autlink_type type integer        Code du type de lien autlink_reciproc type boolean        Le lien est-il réciproque (0 ou 1) ? autlink_comment type string        Commentaire associé au lien

   notice_ids type tableau de integer

   
   
   
   Sommaire

7. get_subcollection_information_and_notices

   Nom de la méthode:
   get_subcollection_information_and_notices
   Description:
   Combine les fonctions get_subcollection_information et list_subcollection_notices
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • get_subcollection_information du groupe pmbesCollections, en version 1.0
   • list_subcollection_notices du groupe pmbesCollections, en version 1.0
   • getLinks du groupe pmbesAutLinks, en version 1.0
   Description des entrées:

   subcollection_id type integer

   OPACUserId type integer

   Description des retours:

   information type sous_collection sous_collection_id type integer        Id de la sous-collection sous_collection_name type string        Nom de la sous collection sous_collection_parent type integer        Id de la collection associée sous_collection_issn type string        ISSN de la sous-collection sous_collection_web type string        Site web de la sous-collection collection_links type autlink_to type string        Type de l'autorité liée: 1 -> Auteur, 2 -> Catégorie, 3 -> Editeur, 4 -> Collection, 5 -> Sous-collection, 6 -> Titre de série, 7 -> Titre uniforme, 8 -> Indexation autlink_to_id type integer        Id de l'autorité liée autlink_to_libelle type string        Libellé de l'autorité liée autlink_type type integer        Code du type de lien autlink_reciproc type boolean        Le lien est-il réciproque (0 ou 1) ? autlink_comment type string        Commentaire associé au lien

   notice_ids type tableau de integer

   
   
   
   Sommaire