Electre API v1.9.8
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Email: Electre API Team Web: Electre API Team
Authentication
-
oAuth2 authentication.
-
Flow: password
-
Token URL = https://login.electre-ng-horsprod.com/auth/realms/electre/protocol/openid-connect/token
-
Scope | Scope Description |
---|---|
roles | Grants read access to the roles of the user |
Notices
External API endpoints to retrieve the whole notices set as well as update
GET-Notices-by-multiple-EAN
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/notices/eans?ean= \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/notices/eans?ean= HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/notices/eans?ean=',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/notices/eans',
params: {
'ean' => 'array[string]'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/notices/eans', params={
'ean': ''
}, headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/notices/eans', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/notices/eans?ean=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/notices/eans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notices/eans
Notices by multiple EAN endpoint
API to get notices by multiple EAN
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
catalogue | query | string | false | Type de catalogue : livre, film, musique ou jeu-video |
ean | query | array[string] | true | EAN de l'ouvrage recherché. Répétable. Limité à 100 ean. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» notices | [object] | true | none | Liste des notices renvoyées par la requête, une notice regroupe l'ensemble des données commerciales, bibliographiques et de classement |
»» resumeElectre | string | false | none | Résumé Electre SEO |
»» anciennesEditionsEan | [string] | false | none | EANs des précédentes éditions. Cas des ouvrages millésimés (guides touristiques, codes réglementaires |
»» typeProduit | object | false | none | Type de produit de l'article (classification simple: ce support est celui du type de produits proposé sur le portail Electre NG et qui permet de distinguer les types de produits différents d'un livre papier dans une liste de résultat ou dans une notice) Un seul type de produit par article. Ce champ était historiquement appelé "support" en API V3. |
»»» typeProduitId | string | true | none | code du type de produit |
»»» libelleTypeProduit | string | true | none | description du type de produit |
»» flagScolaire | boolean | false | none | Indique si l'ouvrage est un ouvrage scolaire au sens juridique du terme (true) Les livres scolaires font l’objet de dispositions juridiques particulières au regard de la loi sur le prix unique du livre (loi du 10 août 1981) et de la loi sur le droit de prêt (loi du 18 juin 2003). Le décret 2004-922 du 31 août 2004 a reprécisé la définition du livre scolaire pour l’application de ces dispositions. |
»» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
»» catalogue | string | true | none | Ouvrage issu du catalogue : livre Si la valeur donnée est différente des valeurs autorisées, une erreur de validation va être retournée. |
»» autresFormats | [object] | false | none | lien entre papier et formats numériques (référence croisée) |
»»» noticeLieeEan | string | true | none | identifiant de la notice en lien |
»»» formatLivreLie | string | true | none | nom du format (PDF, ePub, papier). Dans le cadre des packs numériques, ce champ contient l'ensemble des formats séparés par des virgules. |
»» mentionsEdition | string | false | none | Mentions d'édition précisant une caractéristique de l'édition (révisée, nouvelle, augmentée...) |
»» dateParution | string | false | none | Date de parution au format YYYY-MM-DD |
»» prixDeLancement | object | false | none | Prix de lancement de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes |
»»»» taxeId | string | true | none | Identifiant la taxe |
»»»» horsTaxe | number(double) | true | none | montant de lancement hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | tva sur le produit |
»»» ttc | number(double) | true | none | montant de lancement TTC |
»»» dateDebut | string | true | none | Début de la période durant laquelle le prix de lancement s'applique |
»»» dateFin | string | true | none | Fin de la période durant laquelle le prix de lancement s'applique |
»» quatriemeDeCouvertureResume | string | false | none | Résumé éditeur issu de la quatrième de couverture; temporairement renseigné par un texte Electre tant que la 4e n'est pas disponible |
»» clilFel | object | false | none | Classification CLIL issue de Dilicom |
»»» clilFelId | string | true | none | code CLIL FEL (Dilicom) |
»»» libelleClilFel | string | true | none | libellé CLIL FEL (Dilicom) |
»» anneeEdition | string | false | none | Année d'édition au format YYYY |
»» quatriemeDeCouverture | string | false | none | Résumé éditeur issu de la quatrième de couverture |
»» languesEcriture | [object] | false | none | Langues dans lesquelles est écrit l'ouvrage. (Plusieurs langue possible). |
»»» codeLangue | string | true | none | none |
»»» libelleLangue | string | true | none | none |
»» biographie | string | false | none | Texte de la biographie (ou des biographies si plusieurs contributeurs) le cas échéant dans plusieurs langues pour certains ouvrages multilingues), issu de la quatrième de couverture. Ce contenu présrente des balises HTML notamment pour séparer les différentes versions linguistiques lorsque les biographies sont multilingues EXEMPLE : 9782908445077 |
»» eansErrones | [string] | false | none | EANs communiqués par erreur par l'éditeur, utile pour la recherche |
»» collections | [object] | false | none | collection d'ouvrages chez un éditeur Ce champ est aussi utilisé pour diffuser les revues |
»»» collectionId | string | true | none | identifiant de la collection |
»»» libelleCollection | string | true | none | libellé de la collection |
»»» issn | string | false | none | code ISSN de la collection |
»»» noDeCollection | string | false | none | numéro de l'ouvrage dans la collection |
»»» sousCollection | object | false | none | sous-collection d'ouvrages chez un éditeur |
»»»» sousCollectionId | string | true | none | identifiant de la sous-collection |
»»»» libelleSousCollection | string | true | none | libellé de la sous-collection |
»»»» issnSousCollection | string | false | none | code ISSN de la sous-collection |
»»»» noDeSousCollection | string | false | none | numéro de l'ouvrage dans la sous-collection |
»»»» sousSousCollection | object | false | none | sous-sous-collection d'ouvrages chez un éditeur |
»»»»» sousSousCollectionId | string | true | none | identifiant de la sous-sous-collection |
»»»»» libelleSousSousCollection | string | true | none | libellé de la sous-sous-collection |
»»»»» issnSousSousCollection | string | true | none | code ISSN de la sous-sous-collection |
»»»»» noDeSousSousCollection | string | true | none | numéro de l'ouvrage dans la sous-sous-collection |
»» descriptionsEbook | object | false | none | caractéristiques d'un livre numérique |
»»» formatEbook | string | true | none | format numérique; en cas de pack numérique, tous les formats du pack sont exposés |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» typeVolume | string | false | none | type de volume |
»»» protectionEbook | string | false | none | type de protection de l'ebook |
»»» droitsEbook | [object] | false | none | droits de l'ebook |
»»»» utilisation | string | true | none | none |
»»»» limitation | string | true | none | none |
»»» resumeEbook | string | false | none | résumé du livre et/ou texte de l'équivalent 4ème de couverture |
»»» poidsEbook | string | false | none | poids en mégaoctets du fichier numérique |
»»» packEbookContenus | [object] | false | none | fourni le détail des informations des différents fichiers d'un pack numérique : EAN de chaque fichier, format, protection, droits, poids... |
»»»» formatEbookContenu | string | true | none | none |
»»»» typeVolume | string | false | none | type de volume |
»»»» poidsEbookContenu | number(double) | false | none | none |
»»»» eanEbookContenu | string | false | none | none |
»»»» venduSeul | boolean | false | none | Indique si le livre numérique dans un format de fichier donné peut être vendu seul |
»»»» nbVolumes | string | false | none | nombre de volumes |
»»»» droitsEbookContenu | [object] | false | none | none |
»»»»» utilisation | string | true | none | none |
»»»»» limitation | string | true | none | none |
»»»» descriptionEbookContenu | string | false | none | none |
»»»» protectionEbookContenu | string | false | none | none |
»» image160pxCouverture | string | false | none | URL de l'imagette desktop de la couverture au format JPG de taille 160 pixels de large |
»» support | object | false | none | Support classification étendue, granularité plus fine que celle du code type de produit : ce support est identique à celui du portail V2 ainsi qu'au support du portail NG. Ce champ était historiquement appelé "support étendu" en API V3. |
»»» supportId | string | true | none | code du support |
»»» libelleSupport | string | true | none | libellé du support |
»» titre | string | true | none | Titre complet de l'ouvrage construit à partir de plusieurs titres |
»» rayonsElectreEtendu | [object] | false | none | classification étendue (env. 750 entrées) |
»»» rayonElectreEtenduId | string | true | none | code rayon Electre, classification étendue |
»»» libelleRayonElectreEtendu | string | true | none | libellé rayon Electre, classification étendue |
»» imageCouverture | string | false | none | URL de l'image de la couverture au format JPG à la taille maximale |
»» isbnsErrones | [string] | false | none | ISBNs communiqués par erreur par l'éditeur, utile pour la recherche |
»» legacyNoticeId | string | true | none | Identifiant de la notice chez Electre utilisé dans les systèmes Legacy V2 et V3. C'est cet ID qui doit être utilisé par tous les système tiers précemment alimentés par les versions V2 et V3 de la base electre. |
»» extraitPlayer | string | false | none | Extrait + player consommés ensemble (URL) |
»» themaQualificatifs | [object] | false | none | Composante qualificatif de la classification internationale Thema |
»»» themaQualifId | string | true | none | code du qualificatif Thema |
»»» libelleThemaQualif | string | true | none | libellé du qualificatif Thema |
»» imagetteCouverture | string | false | none | URL de l'imagette mobile de la couverture au format JPG de taille 80 pixels de large |
»» auteursSecondaires | [object] | false | none | liste des contributeurs secondaires à l'ouvrage |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»»» nom | string | true | none | nom du contributeur |
»»» formebib | string | false | none | forme bibliographique complet du nom du contributeur |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» prenom | string | false | none | prénom du contributeur |
»»» nationalites | [object] | false | none | nationalité(s) du contributeur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» auteurId | string | true | none | none |
»»» typeContribution | string | true | none | Type de contribution secondaire Enumerated values in: ["Traducteur", "Directeur de publication", "Editeur scientifique (ou intellectuel)", "Commentateur de texte", "Inconnu", "Auteur de l’idée originale", "Rédacteur / Rapporteur", "Photographe" "Illustrateur", "Coloriste", "Calligraphe", "Cartographe", "Auteur du matériel d'accompagnement", "Maquettiste", "Préfacier", "Postfacier", "Organisateur d’un congrès", "Organisateur d’une exposition", "Commentateur audio", "Photographe (film)", "Chorégraphe", "Directeur artistique", "Autres", "Collaborateur", "Narrateur", "Chef d'une interprétation musicale", "Soliste vocal", "Soliste instrumental", "Groupe musical", "Chanteur","Acteur", "Danseur", "Autres interprètes", "Directeur de collection", "Fondateur d'une revue, d'une collection"] |
»»» langueTraduction | [object] | false | none | pour les traducteurs, langue d'origine de l'ouvrage |
»»»» codeLangue | string | true | none | none |
»»»» libelleLangue | string | true | none | none |
»» eansJustes | [string] | false | none | EANs corrects |
»» distributeur | object | false | none | Distributeur |
»»» distributeurId | string | true | none | identifiant du distributeur Electre |
»»» distributeurNoticeRef | string | false | none | Référence de la notice chez le distributeur |
»»» globalLocationNumber | integer(int64) | false | none | code distributeur GLN (Global Location Number) |
»»» raisonSociale | string | true | none | raison sociale du distributeur |
»» dewey | [object] | false | none | Classification Dewey |
»»» codeDewey | string | true | none | code Dewey |
»»» libelleDewey | string | true | none | libellé Dewey |
»» editeurs | [object] | true | none | Editeurs |
»»» editeurId | string | true | none | identifiant Electre de l'éditeur |
»»» formeBibEditeur | string | true | none | Forme bibliographique de l'éditeur |
»»» lieuPublication | string | true | none | Ville du lieu d'édition |
»» groupeTitres | object | true | none | Ensemble de titres, sous-titres et mentions associés |
»»» titreRevue | object | false | none | none |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroRevue | string | false | none | none |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»» titresDensemble | [object] | false | none | Type de groupe de titres titre d'ensemble |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroVolume | string | false | none | Les numéros de revues et les numéros de volumes de livres sont envoyés dans ce même champs. NB Tomaison : Les deux notions de "tome" (subdivision littéraire d'un ouvrage) et de "volume" (subdivision physique) ne sont pas distinguées dans la base Electre (depuis 2010). Un ouvrage pourra avoir un n° de volume (en tant que n° de volume physique) et un n° de volume (en tant que tome) Par ailleurs, les deux informations de volumaison et de tomaison n'étant pas systématiquement répertoriées sur la page de titre par les éditeurs, ses informations ne sont pas systèmatiquement intégrées dans la base Electre. Seuls les titres d'ensemble possèdent des n° de volume. |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitre | string | false | none | Sous titre |
»»» titresPrincipaux | [object] | false | none | Type de groupe de titres principaux. Il est possible d'avoir un titre d'ensemble sans titre principal |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»»» titresContenus | [object] | false | none | Titres contenus dans un ouvrage qui comprend plusieurs titres (recueil, intégrale, etc.) |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»» isbnsUtilises | [string] | false | none | ISBNs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
»» source | string | true | none | Source de la notice (electre, btlf, olf, dilicom) Les sources disponibles dépendent de l'abonnement souscrit. |
»» nouvellesEditionsEan | [string] | false | none | Les EANs aux éditions suivantes |
»» coffret | boolean | false | none | none |
»» felLibelleCaisse | string | false | none | Désignation courte du produit (20 caractères) permettant au consommateur de faire le rapprochement entre les articles achetés et les lignes de son ticket de caisse. |
»» extrait | object | false | none | URL de l'extrait fourni par l'éditeur au format epub ou pdf |
»»» extraitUrl | string | false | none | URL de l'extrait au format epub ou pdf |
»»» extraitFormat | string | false | none | format de l'extrait |
»» rayonsElectre | [object] | false | none | classification simple (env. 200 entrées) |
»»» rayonElectreId | string | true | none | code rayon Electre, classification simple |
»»» libelleRayonElectre | string | true | none | libellé rayon Electre, classification simple |
»» series | [object] | false | none | série d'ouvrages chez un éditeur donné |
»»» serieId | string | true | none | identifiant de la série |
»»» titreSerie | string | true | none | titre de la série |
»»» numeroSerie | string | false | none | rang de l'ouvrage dans la série |
»»» serieIssn | string | false | none | N° ISSN de la série |
»» noticeId | string | true | none | Identifiant de la notice chez Electre dans le nouveau référentiel mis en place sur Electre NG. |
»» isbns | [string] | false | none | International Standard Book Number (ISBN 13) |
»» felCodeRetour | integer(int64) | false | none | Code indiquant si cet article peut être ou non retourné. - "retour-possible-selon-CGV" (code retour Dilicom 1) - "retour-interdit" (code retour Dilicom 2) - "retour-interdit-sauf-accord-cial" (code retour Dilicom 3) - "retour-sur-couverture" (code retour Dilicom 5) - "retour-sur-couverture-obligatoire" (code retour Dilicom 6) |
»» eans | [string] | true | none | Identifiants EAN de l'ouvrage (plusieurs EAN possibles) |
»» auteursPrincipaux | [object] | false | none | auteurs principaux de l'ouvrage |
»»» auteurId | string | true | none | identifiant de l'auteur |
»»» nom | string | false | none | nom de l'auteur |
»»» prenom | string | false | none | prénom de l'auteur |
»»» formebib | string | true | none | forme bibliographique du nom de l'auteur + qualificatifs |
»»» typeContribution | string | true | none | Type de contribution principale (Auteur, Adaptateur, Producteur, etc.), Enumerated values in: ["Auteur", "Auteur (photographe)", "Auteur (illustrateur)", "Interviewer", "Personne interviewée", "Auteur du texte", "Auteur originel", "Auteur adapté", "Adaptateur", "Auteur douteux, prétendu", "Auteur (artiste)", "Librettiste", "Parolier", "Compositeur", "Programmeur", "Infographiste", "Scénariste", "Dialoguiste", "Concepteur", "Producteur", "Réalisateur de film"] |
»»» nationalites | [object] | false | none | nationalité(s) de l'auteur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»» themaCategories | [object] | false | none | Composante catégorie de la classification internationale Thema |
»»» themaCategorieId | string | true | none | code de la catégorie Thema |
»»» libelleThemaCategorie | string | true | none | libellé de la catégorie Thema |
»» genres | [object] | false | none | Indexation genre de la base Electre |
»»» genreId | string | true | none | Code pour toute la branche |
»»» libelleGenre | string | true | none | Libellé de toute la branche |
»» isbnsJustes | [string] | false | none | ISBNs corrects |
»» felImpressionDemande | boolean | false | none | désigne les articles en impression à la demande. L'IAD est aussi un type de produit envoyé dans le champ "support" |
»» prix | object | true | none | Prix de vente de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»» ttc | number(double) | true | none | Montant TTC |
»» theme | object | false | none | Indexation Theme de la base Electre |
»»» themeId | string | true | none | Code pour toute la branche |
»»» libelleTheme | string | true | none | Libellé de toute la branche |
»» descriptionPhysique | object | false | none | caractéristiques physiques de l'article |
»»» hauteur | number(double) | false | none | hauteur de l'ouvrage, en centimètres |
»»» duree | string | false | none | durée de l'ouvrage |
»»» largeur | number(double) | false | none | largeur de l'ouvrage, en centimètres |
»»» typeVolume | string | false | none | type de volume |
»»» mentionIllustrations | string | false | none | types d'illustrations (illustrations en couleur, en noir et blanc) |
»»» reliure | string | false | none | type de reliure de l'ouvrage |
»»» poids | integer(int64) | false | none | poids de l'ouvrage, en grammes |
»»» nbPages | string | false | none | nombre de pages |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» epaisseur | number(double) | false | none | épaisseur de l'ouvrage, en centimètres |
»» mesChampsExtras | object | false | none | none |
»»» stock | integer(int64) | false | none | none |
»»» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»»»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
»»» populariteOrganisation | integer(int64) | false | none | La popularité organisation, ajoutée à la popularité Electre pour augmenter le score lors d'une recherche. Doit être positive. |
»»» champLibre10 | string | false | none | champ libre 10, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre2 | string | false | none | champ libre 2, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre1 | string | false | none | champ libre 1, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre7 | string | false | none | champ libre 7, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» delaiLivraison | string | false | none | none |
»»» champLibre8 | string | false | none | champ libre 8, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre6 | string | false | none | champ libre 6, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre4 | string | false | none | champ libre 4, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» nombreVues | integer(int64) | false | none | none |
»»» prixPromo | object | false | none | Prix de vente de l'ouvrage |
»»»» devise | string | true | none | Code ISO de la devise |
»»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»»» ttc | number(double) | true | none | Montant TTC |
»»» champLibre5 | string | false | none | champ libre 5, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» prix | object | false | none | Prix de vente de l'ouvrage |
»»»» devise | string | true | none | Code ISO de la devise |
»»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»»» ttc | number(double) | true | none | Montant TTC |
»»» ventes | integer(int64) | false | none | none |
»»» champLibre9 | string | false | none | champ libre 9, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre3 | string | false | none | champ libre 3, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»» publics | [object] | false | none | lectorat |
»»» publicId | string | true | none | code du type de public |
»»» libellePublic | string | true | none | description du type de public |
»» flagFiction | boolean | false | none | Indique s'il s'agit d'un ouvrage de fiction ou non. |
»» disponibilite | string | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "manquant", "a-paraitre", "disponible"] |
»» desactive | boolean | true | none | Indique si la notice a existé mais a été désactivée. Toujours à FALSE pour le endpoint /init, parfois à TRUE pour le endpoint /updated. |
»» disponibiliteEtendue | object | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "arret de commercialisation", "ne sera plus distribue", "reimpression en cours", "manque provisoirement", "a-paraitre", "disponible"] |
»»» disponibiliteEtendueId | integer(int64) | true | none | Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 Mapping : disponible 1 a-paraitre 2 reimpression-en-cours 3 manque-provisoirement 4 epuise 5 arret-de-commercialisation 6 ne-sera-plus-distribue 7 a-reparaitre 8 parution-annulee 9 |
»»» disponibiliteEtendueLibelle | string | true | none | Valeur de disponibilité parmi - disponible - a-paraitre - reimpression-en-cours - manque-provisoirement - epuise - arret-de-commercialisation - ne-sera-plus-distribue - a-reparaitre - parution-annulee |
»» eansUtilises | [string] | false | none | EANs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
» total | integer(int64) | true | none | Nombre total de notices |
GET-Notices-Updated
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/notices/updated?from=&lastndays= \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/notices/updated?from=&lastndays= HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/notices/updated?from=&lastndays=',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/notices/updated',
params: {
'from' => 'string',
'lastndays' => 'integer'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/notices/updated', params={
'from': '', 'lastndays': ''
}, headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/notices/updated', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/notices/updated?from=&lastndays=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/notices/updated", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notices/updated
Updated Notices endpoint
API to fetch the updated notices in a period in a paginated way
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
catalogue | query | string | false | Type de catalogue : livre, film, musique ou jeu-video |
from | query | string | true | timestamp au format ISO-8601 YYYY-MM-DDTHH:mm:ss filtrant toutes les notices modifiées ou créés depuis ce timestamp (peut remonter jusqu'à 90 jours) |
lastndays | query | integer | true | nombre entier positif indiquant la période de filtre en nombre de jour à partir de l'appel (ex: lastndays=2 exécuté le 3 janvier 2020 à 13h filtre les notices modifiées depuis le 1 janvier à 13h). C'est un paramètre de confort pour indiquer facilement les derniers jours sur lesquels le client souhaite avoir les notices modifiées. |
limit | query | integer | false | Quantité maximale de notices par page |
offset | query | integer | false | Offset pour la page appelée |
Detailed descriptions
lastndays: nombre entier positif indiquant la période de filtre en nombre de jour à partir de l'appel (ex: lastndays=2 exécuté le 3 janvier 2020 à 13h filtre les notices modifiées depuis le 1 janvier à 13h). C'est un paramètre de confort pour indiquer facilement les derniers jours sur lesquels le client souhaite avoir les notices modifiées. Au moins un des paramètres from ou lastndays est obligatoire, si lastndays est présent il a la priorité sur le paramètre from.
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» limit | integer(int64) | true | none | Quantité maximale de notices par page tel que passé en paramètre |
» nextCursor | string | false | none | Positionnement du prochain curseur afin de récupérer la prochaine portion de notice |
» notices | [object] | true | none | Liste des notices renvoyées par la requête, une notice regroupe l'ensemble des données commerciales, bibliographiques et de classement |
»» resumeElectre | string | false | none | Résumé Electre SEO |
»» anciennesEditionsEan | [string] | false | none | EANs des précédentes éditions. Cas des ouvrages millésimés (guides touristiques, codes réglementaires |
»» typeProduit | object | false | none | Type de produit de l'article (classification simple: ce support est celui du type de produits proposé sur le portail Electre NG et qui permet de distinguer les types de produits différents d'un livre papier dans une liste de résultat ou dans une notice) Un seul type de produit par article. Ce champ était historiquement appelé "support" en API V3. |
»»» typeProduitId | string | true | none | code du type de produit |
»»» libelleTypeProduit | string | true | none | description du type de produit |
»» flagScolaire | boolean | false | none | Indique si l'ouvrage est un ouvrage scolaire au sens juridique du terme (true) Les livres scolaires font l’objet de dispositions juridiques particulières au regard de la loi sur le prix unique du livre (loi du 10 août 1981) et de la loi sur le droit de prêt (loi du 18 juin 2003). Le décret 2004-922 du 31 août 2004 a reprécisé la définition du livre scolaire pour l’application de ces dispositions. |
»» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
»» catalogue | string | true | none | Ouvrage issu du catalogue : livre Si la valeur donnée est différente des valeurs autorisées, une erreur de validation va être retournée. |
»» autresFormats | [object] | false | none | lien entre papier et formats numériques (référence croisée) |
»»» noticeLieeEan | string | true | none | identifiant de la notice en lien |
»»» formatLivreLie | string | true | none | nom du format (PDF, ePub, papier). Dans le cadre des packs numériques, ce champ contient l'ensemble des formats séparés par des virgules. |
»» mentionsEdition | string | false | none | Mentions d'édition précisant une caractéristique de l'édition (révisée, nouvelle, augmentée...) |
»» dateParution | string | false | none | Date de parution au format YYYY-MM-DD |
»» prixDeLancement | object | false | none | Prix de lancement de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes |
»»»» taxeId | string | true | none | Identifiant la taxe |
»»»» horsTaxe | number(double) | true | none | montant de lancement hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | tva sur le produit |
»»» ttc | number(double) | true | none | montant de lancement TTC |
»»» dateDebut | string | true | none | Début de la période durant laquelle le prix de lancement s'applique |
»»» dateFin | string | true | none | Fin de la période durant laquelle le prix de lancement s'applique |
»» quatriemeDeCouvertureResume | string | false | none | Résumé éditeur issu de la quatrième de couverture; temporairement renseigné par un texte Electre tant que la 4e n'est pas disponible |
»» clilFel | object | false | none | Classification CLIL issue de Dilicom |
»»» clilFelId | string | true | none | code CLIL FEL (Dilicom) |
»»» libelleClilFel | string | true | none | libellé CLIL FEL (Dilicom) |
»» anneeEdition | string | false | none | Année d'édition au format YYYY |
»» quatriemeDeCouverture | string | false | none | Résumé éditeur issu de la quatrième de couverture |
»» languesEcriture | [object] | false | none | Langues dans lesquelles est écrit l'ouvrage. (Plusieurs langue possible). |
»»» codeLangue | string | true | none | none |
»»» libelleLangue | string | true | none | none |
»» biographie | string | false | none | Texte de la biographie (ou des biographies si plusieurs contributeurs) le cas échéant dans plusieurs langues pour certains ouvrages multilingues), issu de la quatrième de couverture. Ce contenu présrente des balises HTML notamment pour séparer les différentes versions linguistiques lorsque les biographies sont multilingues EXEMPLE : 9782908445077 |
»» eansErrones | [string] | false | none | EANs communiqués par erreur par l'éditeur, utile pour la recherche |
»» collections | [object] | false | none | collection d'ouvrages chez un éditeur Ce champ est aussi utilisé pour diffuser les revues |
»»» collectionId | string | true | none | identifiant de la collection |
»»» libelleCollection | string | true | none | libellé de la collection |
»»» issn | string | false | none | code ISSN de la collection |
»»» noDeCollection | string | false | none | numéro de l'ouvrage dans la collection |
»»» sousCollection | object | false | none | sous-collection d'ouvrages chez un éditeur |
»»»» sousCollectionId | string | true | none | identifiant de la sous-collection |
»»»» libelleSousCollection | string | true | none | libellé de la sous-collection |
»»»» issnSousCollection | string | false | none | code ISSN de la sous-collection |
»»»» noDeSousCollection | string | false | none | numéro de l'ouvrage dans la sous-collection |
»»»» sousSousCollection | object | false | none | sous-sous-collection d'ouvrages chez un éditeur |
»»»»» sousSousCollectionId | string | true | none | identifiant de la sous-sous-collection |
»»»»» libelleSousSousCollection | string | true | none | libellé de la sous-sous-collection |
»»»»» issnSousSousCollection | string | true | none | code ISSN de la sous-sous-collection |
»»»»» noDeSousSousCollection | string | true | none | numéro de l'ouvrage dans la sous-sous-collection |
»» descriptionsEbook | object | false | none | caractéristiques d'un livre numérique |
»»» formatEbook | string | true | none | format numérique; en cas de pack numérique, tous les formats du pack sont exposés |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» typeVolume | string | false | none | type de volume |
»»» protectionEbook | string | false | none | type de protection de l'ebook |
»»» droitsEbook | [object] | false | none | droits de l'ebook |
»»»» utilisation | string | true | none | none |
»»»» limitation | string | true | none | none |
»»» resumeEbook | string | false | none | résumé du livre et/ou texte de l'équivalent 4ème de couverture |
»»» poidsEbook | string | false | none | poids en mégaoctets du fichier numérique |
»»» packEbookContenus | [object] | false | none | fourni le détail des informations des différents fichiers d'un pack numérique : EAN de chaque fichier, format, protection, droits, poids... |
»»»» formatEbookContenu | string | true | none | none |
»»»» typeVolume | string | false | none | type de volume |
»»»» poidsEbookContenu | number(double) | false | none | none |
»»»» eanEbookContenu | string | false | none | none |
»»»» venduSeul | boolean | false | none | Indique si le livre numérique dans un format de fichier donné peut être vendu seul |
»»»» nbVolumes | string | false | none | nombre de volumes |
»»»» droitsEbookContenu | [object] | false | none | none |
»»»»» utilisation | string | true | none | none |
»»»»» limitation | string | true | none | none |
»»»» descriptionEbookContenu | string | false | none | none |
»»»» protectionEbookContenu | string | false | none | none |
»» image160pxCouverture | string | false | none | URL de l'imagette desktop de la couverture au format JPG de taille 160 pixels de large |
»» support | object | false | none | Support classification étendue, granularité plus fine que celle du code type de produit : ce support est identique à celui du portail V2 ainsi qu'au support du portail NG. Ce champ était historiquement appelé "support étendu" en API V3. |
»»» supportId | string | true | none | code du support |
»»» libelleSupport | string | true | none | libellé du support |
»» titre | string | true | none | Titre complet de l'ouvrage construit à partir de plusieurs titres |
»» rayonsElectreEtendu | [object] | false | none | classification étendue (env. 750 entrées) |
»»» rayonElectreEtenduId | string | true | none | code rayon Electre, classification étendue |
»»» libelleRayonElectreEtendu | string | true | none | libellé rayon Electre, classification étendue |
»» imageCouverture | string | false | none | URL de l'image de la couverture au format JPG à la taille maximale |
»» isbnsErrones | [string] | false | none | ISBNs communiqués par erreur par l'éditeur, utile pour la recherche |
»» legacyNoticeId | string | true | none | Identifiant de la notice chez Electre utilisé dans les systèmes Legacy V2 et V3. C'est cet ID qui doit être utilisé par tous les système tiers précemment alimentés par les versions V2 et V3 de la base electre. |
»» extraitPlayer | string | false | none | Extrait + player consommés ensemble (URL) |
»» themaQualificatifs | [object] | false | none | Composante qualificatif de la classification internationale Thema |
»»» themaQualifId | string | true | none | code du qualificatif Thema |
»»» libelleThemaQualif | string | true | none | libellé du qualificatif Thema |
»» imagetteCouverture | string | false | none | URL de l'imagette mobile de la couverture au format JPG de taille 80 pixels de large |
»» auteursSecondaires | [object] | false | none | liste des contributeurs secondaires à l'ouvrage |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»»» nom | string | true | none | nom du contributeur |
»»» formebib | string | false | none | forme bibliographique complet du nom du contributeur |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» prenom | string | false | none | prénom du contributeur |
»»» nationalites | [object] | false | none | nationalité(s) du contributeur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» auteurId | string | true | none | none |
»»» typeContribution | string | true | none | Type de contribution secondaire Enumerated values in: ["Traducteur", "Directeur de publication", "Editeur scientifique (ou intellectuel)", "Commentateur de texte", "Inconnu", "Auteur de l’idée originale", "Rédacteur / Rapporteur", "Photographe" "Illustrateur", "Coloriste", "Calligraphe", "Cartographe", "Auteur du matériel d'accompagnement", "Maquettiste", "Préfacier", "Postfacier", "Organisateur d’un congrès", "Organisateur d’une exposition", "Commentateur audio", "Photographe (film)", "Chorégraphe", "Directeur artistique", "Autres", "Collaborateur", "Narrateur", "Chef d'une interprétation musicale", "Soliste vocal", "Soliste instrumental", "Groupe musical", "Chanteur","Acteur", "Danseur", "Autres interprètes", "Directeur de collection", "Fondateur d'une revue, d'une collection"] |
»»» langueTraduction | [object] | false | none | pour les traducteurs, langue d'origine de l'ouvrage |
»»»» codeLangue | string | true | none | none |
»»»» libelleLangue | string | true | none | none |
»» eansJustes | [string] | false | none | EANs corrects |
»» distributeur | object | false | none | Distributeur |
»»» distributeurId | string | true | none | identifiant du distributeur Electre |
»»» distributeurNoticeRef | string | false | none | Référence de la notice chez le distributeur |
»»» globalLocationNumber | integer(int64) | false | none | code distributeur GLN (Global Location Number) |
»»» raisonSociale | string | true | none | raison sociale du distributeur |
»» dewey | [object] | false | none | Classification Dewey |
»»» codeDewey | string | true | none | code Dewey |
»»» libelleDewey | string | true | none | libellé Dewey |
»» editeurs | [object] | true | none | Editeurs |
»»» editeurId | string | true | none | identifiant Electre de l'éditeur |
»»» formeBibEditeur | string | true | none | Forme bibliographique de l'éditeur |
»»» lieuPublication | string | true | none | Ville du lieu d'édition |
»» groupeTitres | object | true | none | Ensemble de titres, sous-titres et mentions associés |
»»» titreRevue | object | false | none | none |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroRevue | string | false | none | none |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»» titresDensemble | [object] | false | none | Type de groupe de titres titre d'ensemble |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroVolume | string | false | none | Les numéros de revues et les numéros de volumes de livres sont envoyés dans ce même champs. NB Tomaison : Les deux notions de "tome" (subdivision littéraire d'un ouvrage) et de "volume" (subdivision physique) ne sont pas distinguées dans la base Electre (depuis 2010). Un ouvrage pourra avoir un n° de volume (en tant que n° de volume physique) et un n° de volume (en tant que tome) Par ailleurs, les deux informations de volumaison et de tomaison n'étant pas systématiquement répertoriées sur la page de titre par les éditeurs, ses informations ne sont pas systèmatiquement intégrées dans la base Electre. Seuls les titres d'ensemble possèdent des n° de volume. |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitre | string | false | none | Sous titre |
»»» titresPrincipaux | [object] | false | none | Type de groupe de titres principaux. Il est possible d'avoir un titre d'ensemble sans titre principal |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»»» titresContenus | [object] | false | none | Titres contenus dans un ouvrage qui comprend plusieurs titres (recueil, intégrale, etc.) |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»» isbnsUtilises | [string] | false | none | ISBNs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
»» source | string | true | none | Source de la notice (electre, btlf, olf, dilicom) Les sources disponibles dépendent de l'abonnement souscrit. |
»» nouvellesEditionsEan | [string] | false | none | Les EANs aux éditions suivantes |
»» coffret | boolean | false | none | none |
»» felLibelleCaisse | string | false | none | Désignation courte du produit (20 caractères) permettant au consommateur de faire le rapprochement entre les articles achetés et les lignes de son ticket de caisse. |
»» extrait | object | false | none | URL de l'extrait fourni par l'éditeur au format epub ou pdf |
»»» extraitUrl | string | false | none | URL de l'extrait au format epub ou pdf |
»»» extraitFormat | string | false | none | format de l'extrait |
»» rayonsElectre | [object] | false | none | classification simple (env. 200 entrées) |
»»» rayonElectreId | string | true | none | code rayon Electre, classification simple |
»»» libelleRayonElectre | string | true | none | libellé rayon Electre, classification simple |
»» series | [object] | false | none | série d'ouvrages chez un éditeur donné |
»»» serieId | string | true | none | identifiant de la série |
»»» titreSerie | string | true | none | titre de la série |
»»» numeroSerie | string | false | none | rang de l'ouvrage dans la série |
»»» serieIssn | string | false | none | N° ISSN de la série |
»» noticeId | string | true | none | Identifiant de la notice chez Electre dans le nouveau référentiel mis en place sur Electre NG. |
»» isbns | [string] | false | none | International Standard Book Number (ISBN 13) |
»» felCodeRetour | integer(int64) | false | none | Code indiquant si cet article peut être ou non retourné. - "retour-possible-selon-CGV" (code retour Dilicom 1) - "retour-interdit" (code retour Dilicom 2) - "retour-interdit-sauf-accord-cial" (code retour Dilicom 3) - "retour-sur-couverture" (code retour Dilicom 5) - "retour-sur-couverture-obligatoire" (code retour Dilicom 6) |
»» eans | [string] | true | none | Identifiants EAN de l'ouvrage (plusieurs EAN possibles) |
»» auteursPrincipaux | [object] | false | none | auteurs principaux de l'ouvrage |
»»» auteurId | string | true | none | identifiant de l'auteur |
»»» nom | string | false | none | nom de l'auteur |
»»» prenom | string | false | none | prénom de l'auteur |
»»» formebib | string | true | none | forme bibliographique du nom de l'auteur + qualificatifs |
»»» typeContribution | string | true | none | Type de contribution principale (Auteur, Adaptateur, Producteur, etc.), Enumerated values in: ["Auteur", "Auteur (photographe)", "Auteur (illustrateur)", "Interviewer", "Personne interviewée", "Auteur du texte", "Auteur originel", "Auteur adapté", "Adaptateur", "Auteur douteux, prétendu", "Auteur (artiste)", "Librettiste", "Parolier", "Compositeur", "Programmeur", "Infographiste", "Scénariste", "Dialoguiste", "Concepteur", "Producteur", "Réalisateur de film"] |
»»» nationalites | [object] | false | none | nationalité(s) de l'auteur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»» themaCategories | [object] | false | none | Composante catégorie de la classification internationale Thema |
»»» themaCategorieId | string | true | none | code de la catégorie Thema |
»»» libelleThemaCategorie | string | true | none | libellé de la catégorie Thema |
»» genres | [object] | false | none | Indexation genre de la base Electre |
»»» genreId | string | true | none | Code pour toute la branche |
»»» libelleGenre | string | true | none | Libellé de toute la branche |
»» isbnsJustes | [string] | false | none | ISBNs corrects |
»» felImpressionDemande | boolean | false | none | désigne les articles en impression à la demande. L'IAD est aussi un type de produit envoyé dans le champ "support" |
»» prix | object | true | none | Prix de vente de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»» ttc | number(double) | true | none | Montant TTC |
»» theme | object | false | none | Indexation Theme de la base Electre |
»»» themeId | string | true | none | Code pour toute la branche |
»»» libelleTheme | string | true | none | Libellé de toute la branche |
»» descriptionPhysique | object | false | none | caractéristiques physiques de l'article |
»»» hauteur | number(double) | false | none | hauteur de l'ouvrage, en centimètres |
»»» duree | string | false | none | durée de l'ouvrage |
»»» largeur | number(double) | false | none | largeur de l'ouvrage, en centimètres |
»»» typeVolume | string | false | none | type de volume |
»»» mentionIllustrations | string | false | none | types d'illustrations (illustrations en couleur, en noir et blanc) |
»»» reliure | string | false | none | type de reliure de l'ouvrage |
»»» poids | integer(int64) | false | none | poids de l'ouvrage, en grammes |
»»» nbPages | string | false | none | nombre de pages |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» epaisseur | number(double) | false | none | épaisseur de l'ouvrage, en centimètres |
»» publics | [object] | false | none | lectorat |
»»» publicId | string | true | none | code du type de public |
»»» libellePublic | string | true | none | description du type de public |
»» flagFiction | boolean | false | none | Indique s'il s'agit d'un ouvrage de fiction ou non. |
»» disponibilite | string | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "manquant", "a-paraitre", "disponible"] |
»» desactive | boolean | true | none | Indique si la notice a existé mais a été désactivée. Toujours à FALSE pour le endpoint /init, parfois à TRUE pour le endpoint /updated. |
»» disponibiliteEtendue | object | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "arret de commercialisation", "ne sera plus distribue", "reimpression en cours", "manque provisoirement", "a-paraitre", "disponible"] |
»»» disponibiliteEtendueId | integer(int64) | true | none | Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 Mapping : disponible 1 a-paraitre 2 reimpression-en-cours 3 manque-provisoirement 4 epuise 5 arret-de-commercialisation 6 ne-sera-plus-distribue 7 a-reparaitre 8 parution-annulee 9 |
»»» disponibiliteEtendueLibelle | string | true | none | Valeur de disponibilité parmi - disponible - a-paraitre - reimpression-en-cours - manque-provisoirement - epuise - arret-de-commercialisation - ne-sera-plus-distribue - a-reparaitre - parution-annulee |
»» eansUtilises | [string] | false | none | EANs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total de notices |
GET-Notices
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/notices \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/notices HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/notices',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/notices',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/notices', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/notices', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/notices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/notices", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notices
Notices Initialization endpoint
API to fetch all the notices in a paginated way.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
catalogue | query | string | false | Type de catalogue : livre, film, musique ou jeu-video |
cursor | query | string | false | Curseur permettant de récupérer la prochaine portion de notice (valeur à mettre à "*" afin de priviligier le mode curseur) |
ean | query | string | false | EAN de l'ouvrage recherché |
limit | query | integer | false | Quantité maximale de notices par page |
offset | query | integer | false | Offset pour la page appelée |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» limit | integer(int64) | true | none | Quantité maximale de notices par page tel que passé en paramètre |
» nextCursor | string | false | none | Positionnement du prochain curseur afin de récupérer la prochaine portion de notice |
» notices | [object] | true | none | Liste des notices renvoyées par la requête, une notice regroupe l'ensemble des données commerciales, bibliographiques et de classement |
»» resumeElectre | string | false | none | Résumé Electre SEO |
»» anciennesEditionsEan | [string] | false | none | EANs des précédentes éditions. Cas des ouvrages millésimés (guides touristiques, codes réglementaires |
»» typeProduit | object | false | none | Type de produit de l'article (classification simple: ce support est celui du type de produits proposé sur le portail Electre NG et qui permet de distinguer les types de produits différents d'un livre papier dans une liste de résultat ou dans une notice) Un seul type de produit par article. Ce champ était historiquement appelé "support" en API V3. |
»»» typeProduitId | string | true | none | code du type de produit |
»»» libelleTypeProduit | string | true | none | description du type de produit |
»» flagScolaire | boolean | false | none | Indique si l'ouvrage est un ouvrage scolaire au sens juridique du terme (true) Les livres scolaires font l’objet de dispositions juridiques particulières au regard de la loi sur le prix unique du livre (loi du 10 août 1981) et de la loi sur le droit de prêt (loi du 18 juin 2003). Le décret 2004-922 du 31 août 2004 a reprécisé la définition du livre scolaire pour l’application de ces dispositions. |
»» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
»» catalogue | string | true | none | Ouvrage issu du catalogue : livre Si la valeur donnée est différente des valeurs autorisées, une erreur de validation va être retournée. |
»» autresFormats | [object] | false | none | lien entre papier et formats numériques (référence croisée) |
»»» noticeLieeEan | string | true | none | identifiant de la notice en lien |
»»» formatLivreLie | string | true | none | nom du format (PDF, ePub, papier). Dans le cadre des packs numériques, ce champ contient l'ensemble des formats séparés par des virgules. |
»» mentionsEdition | string | false | none | Mentions d'édition précisant une caractéristique de l'édition (révisée, nouvelle, augmentée...) |
»» dateParution | string | false | none | Date de parution au format YYYY-MM-DD |
»» prixDeLancement | object | false | none | Prix de lancement de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes |
»»»» taxeId | string | true | none | Identifiant la taxe |
»»»» horsTaxe | number(double) | true | none | montant de lancement hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | tva sur le produit |
»»» ttc | number(double) | true | none | montant de lancement TTC |
»»» dateDebut | string | true | none | Début de la période durant laquelle le prix de lancement s'applique |
»»» dateFin | string | true | none | Fin de la période durant laquelle le prix de lancement s'applique |
»» quatriemeDeCouvertureResume | string | false | none | Résumé éditeur issu de la quatrième de couverture; temporairement renseigné par un texte Electre tant que la 4e n'est pas disponible |
»» clilFel | object | false | none | Classification CLIL issue de Dilicom |
»»» clilFelId | string | true | none | code CLIL FEL (Dilicom) |
»»» libelleClilFel | string | true | none | libellé CLIL FEL (Dilicom) |
»» anneeEdition | string | false | none | Année d'édition au format YYYY |
»» quatriemeDeCouverture | string | false | none | Résumé éditeur issu de la quatrième de couverture |
»» languesEcriture | [object] | false | none | Langues dans lesquelles est écrit l'ouvrage. (Plusieurs langue possible). |
»»» codeLangue | string | true | none | none |
»»» libelleLangue | string | true | none | none |
»» biographie | string | false | none | Texte de la biographie (ou des biographies si plusieurs contributeurs) le cas échéant dans plusieurs langues pour certains ouvrages multilingues), issu de la quatrième de couverture. Ce contenu présrente des balises HTML notamment pour séparer les différentes versions linguistiques lorsque les biographies sont multilingues EXEMPLE : 9782908445077 |
»» eansErrones | [string] | false | none | EANs communiqués par erreur par l'éditeur, utile pour la recherche |
»» collections | [object] | false | none | collection d'ouvrages chez un éditeur Ce champ est aussi utilisé pour diffuser les revues |
»»» collectionId | string | true | none | identifiant de la collection |
»»» libelleCollection | string | true | none | libellé de la collection |
»»» issn | string | false | none | code ISSN de la collection |
»»» noDeCollection | string | false | none | numéro de l'ouvrage dans la collection |
»»» sousCollection | object | false | none | sous-collection d'ouvrages chez un éditeur |
»»»» sousCollectionId | string | true | none | identifiant de la sous-collection |
»»»» libelleSousCollection | string | true | none | libellé de la sous-collection |
»»»» issnSousCollection | string | false | none | code ISSN de la sous-collection |
»»»» noDeSousCollection | string | false | none | numéro de l'ouvrage dans la sous-collection |
»»»» sousSousCollection | object | false | none | sous-sous-collection d'ouvrages chez un éditeur |
»»»»» sousSousCollectionId | string | true | none | identifiant de la sous-sous-collection |
»»»»» libelleSousSousCollection | string | true | none | libellé de la sous-sous-collection |
»»»»» issnSousSousCollection | string | true | none | code ISSN de la sous-sous-collection |
»»»»» noDeSousSousCollection | string | true | none | numéro de l'ouvrage dans la sous-sous-collection |
»» descriptionsEbook | object | false | none | caractéristiques d'un livre numérique |
»»» formatEbook | string | true | none | format numérique; en cas de pack numérique, tous les formats du pack sont exposés |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» typeVolume | string | false | none | type de volume |
»»» protectionEbook | string | false | none | type de protection de l'ebook |
»»» droitsEbook | [object] | false | none | droits de l'ebook |
»»»» utilisation | string | true | none | none |
»»»» limitation | string | true | none | none |
»»» resumeEbook | string | false | none | résumé du livre et/ou texte de l'équivalent 4ème de couverture |
»»» poidsEbook | string | false | none | poids en mégaoctets du fichier numérique |
»»» packEbookContenus | [object] | false | none | fourni le détail des informations des différents fichiers d'un pack numérique : EAN de chaque fichier, format, protection, droits, poids... |
»»»» formatEbookContenu | string | true | none | none |
»»»» typeVolume | string | false | none | type de volume |
»»»» poidsEbookContenu | number(double) | false | none | none |
»»»» eanEbookContenu | string | false | none | none |
»»»» venduSeul | boolean | false | none | Indique si le livre numérique dans un format de fichier donné peut être vendu seul |
»»»» nbVolumes | string | false | none | nombre de volumes |
»»»» droitsEbookContenu | [object] | false | none | none |
»»»»» utilisation | string | true | none | none |
»»»»» limitation | string | true | none | none |
»»»» descriptionEbookContenu | string | false | none | none |
»»»» protectionEbookContenu | string | false | none | none |
»» image160pxCouverture | string | false | none | URL de l'imagette desktop de la couverture au format JPG de taille 160 pixels de large |
»» support | object | false | none | Support classification étendue, granularité plus fine que celle du code type de produit : ce support est identique à celui du portail V2 ainsi qu'au support du portail NG. Ce champ était historiquement appelé "support étendu" en API V3. |
»»» supportId | string | true | none | code du support |
»»» libelleSupport | string | true | none | libellé du support |
»» titre | string | true | none | Titre complet de l'ouvrage construit à partir de plusieurs titres |
»» rayonsElectreEtendu | [object] | false | none | classification étendue (env. 750 entrées) |
»»» rayonElectreEtenduId | string | true | none | code rayon Electre, classification étendue |
»»» libelleRayonElectreEtendu | string | true | none | libellé rayon Electre, classification étendue |
»» imageCouverture | string | false | none | URL de l'image de la couverture au format JPG à la taille maximale |
»» isbnsErrones | [string] | false | none | ISBNs communiqués par erreur par l'éditeur, utile pour la recherche |
»» legacyNoticeId | string | true | none | Identifiant de la notice chez Electre utilisé dans les systèmes Legacy V2 et V3. C'est cet ID qui doit être utilisé par tous les système tiers précemment alimentés par les versions V2 et V3 de la base electre. |
»» extraitPlayer | string | false | none | Extrait + player consommés ensemble (URL) |
»» themaQualificatifs | [object] | false | none | Composante qualificatif de la classification internationale Thema |
»»» themaQualifId | string | true | none | code du qualificatif Thema |
»»» libelleThemaQualif | string | true | none | libellé du qualificatif Thema |
»» imagetteCouverture | string | false | none | URL de l'imagette mobile de la couverture au format JPG de taille 80 pixels de large |
»» auteursSecondaires | [object] | false | none | liste des contributeurs secondaires à l'ouvrage |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»»» nom | string | true | none | nom du contributeur |
»»» formebib | string | false | none | forme bibliographique complet du nom du contributeur |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» prenom | string | false | none | prénom du contributeur |
»»» nationalites | [object] | false | none | nationalité(s) du contributeur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» auteurId | string | true | none | none |
»»» typeContribution | string | true | none | Type de contribution secondaire Enumerated values in: ["Traducteur", "Directeur de publication", "Editeur scientifique (ou intellectuel)", "Commentateur de texte", "Inconnu", "Auteur de l’idée originale", "Rédacteur / Rapporteur", "Photographe" "Illustrateur", "Coloriste", "Calligraphe", "Cartographe", "Auteur du matériel d'accompagnement", "Maquettiste", "Préfacier", "Postfacier", "Organisateur d’un congrès", "Organisateur d’une exposition", "Commentateur audio", "Photographe (film)", "Chorégraphe", "Directeur artistique", "Autres", "Collaborateur", "Narrateur", "Chef d'une interprétation musicale", "Soliste vocal", "Soliste instrumental", "Groupe musical", "Chanteur","Acteur", "Danseur", "Autres interprètes", "Directeur de collection", "Fondateur d'une revue, d'une collection"] |
»»» langueTraduction | [object] | false | none | pour les traducteurs, langue d'origine de l'ouvrage |
»»»» codeLangue | string | true | none | none |
»»»» libelleLangue | string | true | none | none |
»» eansJustes | [string] | false | none | EANs corrects |
»» distributeur | object | false | none | Distributeur |
»»» distributeurId | string | true | none | identifiant du distributeur Electre |
»»» distributeurNoticeRef | string | false | none | Référence de la notice chez le distributeur |
»»» globalLocationNumber | integer(int64) | false | none | code distributeur GLN (Global Location Number) |
»»» raisonSociale | string | true | none | raison sociale du distributeur |
»» dewey | [object] | false | none | Classification Dewey |
»»» codeDewey | string | true | none | code Dewey |
»»» libelleDewey | string | true | none | libellé Dewey |
»» editeurs | [object] | true | none | Editeurs |
»»» editeurId | string | true | none | identifiant Electre de l'éditeur |
»»» formeBibEditeur | string | true | none | Forme bibliographique de l'éditeur |
»»» lieuPublication | string | true | none | Ville du lieu d'édition |
»» groupeTitres | object | true | none | Ensemble de titres, sous-titres et mentions associés |
»»» titreRevue | object | false | none | none |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroRevue | string | false | none | none |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»» titresDensemble | [object] | false | none | Type de groupe de titres titre d'ensemble |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroVolume | string | false | none | Les numéros de revues et les numéros de volumes de livres sont envoyés dans ce même champs. NB Tomaison : Les deux notions de "tome" (subdivision littéraire d'un ouvrage) et de "volume" (subdivision physique) ne sont pas distinguées dans la base Electre (depuis 2010). Un ouvrage pourra avoir un n° de volume (en tant que n° de volume physique) et un n° de volume (en tant que tome) Par ailleurs, les deux informations de volumaison et de tomaison n'étant pas systématiquement répertoriées sur la page de titre par les éditeurs, ses informations ne sont pas systèmatiquement intégrées dans la base Electre. Seuls les titres d'ensemble possèdent des n° de volume. |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitre | string | false | none | Sous titre |
»»» titresPrincipaux | [object] | false | none | Type de groupe de titres principaux. Il est possible d'avoir un titre d'ensemble sans titre principal |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»»» titresContenus | [object] | false | none | Titres contenus dans un ouvrage qui comprend plusieurs titres (recueil, intégrale, etc.) |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»» isbnsUtilises | [string] | false | none | ISBNs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
»» source | string | true | none | Source de la notice (electre, btlf, olf, dilicom) Les sources disponibles dépendent de l'abonnement souscrit. |
»» nouvellesEditionsEan | [string] | false | none | Les EANs aux éditions suivantes |
»» coffret | boolean | false | none | none |
»» felLibelleCaisse | string | false | none | Désignation courte du produit (20 caractères) permettant au consommateur de faire le rapprochement entre les articles achetés et les lignes de son ticket de caisse. |
»» extrait | object | false | none | URL de l'extrait fourni par l'éditeur au format epub ou pdf |
»»» extraitUrl | string | false | none | URL de l'extrait au format epub ou pdf |
»»» extraitFormat | string | false | none | format de l'extrait |
»» rayonsElectre | [object] | false | none | classification simple (env. 200 entrées) |
»»» rayonElectreId | string | true | none | code rayon Electre, classification simple |
»»» libelleRayonElectre | string | true | none | libellé rayon Electre, classification simple |
»» series | [object] | false | none | série d'ouvrages chez un éditeur donné |
»»» serieId | string | true | none | identifiant de la série |
»»» titreSerie | string | true | none | titre de la série |
»»» numeroSerie | string | false | none | rang de l'ouvrage dans la série |
»»» serieIssn | string | false | none | N° ISSN de la série |
»» noticeId | string | true | none | Identifiant de la notice chez Electre dans le nouveau référentiel mis en place sur Electre NG. |
»» isbns | [string] | false | none | International Standard Book Number (ISBN 13) |
»» felCodeRetour | integer(int64) | false | none | Code indiquant si cet article peut être ou non retourné. - "retour-possible-selon-CGV" (code retour Dilicom 1) - "retour-interdit" (code retour Dilicom 2) - "retour-interdit-sauf-accord-cial" (code retour Dilicom 3) - "retour-sur-couverture" (code retour Dilicom 5) - "retour-sur-couverture-obligatoire" (code retour Dilicom 6) |
»» eans | [string] | true | none | Identifiants EAN de l'ouvrage (plusieurs EAN possibles) |
»» auteursPrincipaux | [object] | false | none | auteurs principaux de l'ouvrage |
»»» auteurId | string | true | none | identifiant de l'auteur |
»»» nom | string | false | none | nom de l'auteur |
»»» prenom | string | false | none | prénom de l'auteur |
»»» formebib | string | true | none | forme bibliographique du nom de l'auteur + qualificatifs |
»»» typeContribution | string | true | none | Type de contribution principale (Auteur, Adaptateur, Producteur, etc.), Enumerated values in: ["Auteur", "Auteur (photographe)", "Auteur (illustrateur)", "Interviewer", "Personne interviewée", "Auteur du texte", "Auteur originel", "Auteur adapté", "Adaptateur", "Auteur douteux, prétendu", "Auteur (artiste)", "Librettiste", "Parolier", "Compositeur", "Programmeur", "Infographiste", "Scénariste", "Dialoguiste", "Concepteur", "Producteur", "Réalisateur de film"] |
»»» nationalites | [object] | false | none | nationalité(s) de l'auteur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»» themaCategories | [object] | false | none | Composante catégorie de la classification internationale Thema |
»»» themaCategorieId | string | true | none | code de la catégorie Thema |
»»» libelleThemaCategorie | string | true | none | libellé de la catégorie Thema |
»» genres | [object] | false | none | Indexation genre de la base Electre |
»»» genreId | string | true | none | Code pour toute la branche |
»»» libelleGenre | string | true | none | Libellé de toute la branche |
»» isbnsJustes | [string] | false | none | ISBNs corrects |
»» felImpressionDemande | boolean | false | none | désigne les articles en impression à la demande. L'IAD est aussi un type de produit envoyé dans le champ "support" |
»» prix | object | true | none | Prix de vente de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»» ttc | number(double) | true | none | Montant TTC |
»» theme | object | false | none | Indexation Theme de la base Electre |
»»» themeId | string | true | none | Code pour toute la branche |
»»» libelleTheme | string | true | none | Libellé de toute la branche |
»» descriptionPhysique | object | false | none | caractéristiques physiques de l'article |
»»» hauteur | number(double) | false | none | hauteur de l'ouvrage, en centimètres |
»»» duree | string | false | none | durée de l'ouvrage |
»»» largeur | number(double) | false | none | largeur de l'ouvrage, en centimètres |
»»» typeVolume | string | false | none | type de volume |
»»» mentionIllustrations | string | false | none | types d'illustrations (illustrations en couleur, en noir et blanc) |
»»» reliure | string | false | none | type de reliure de l'ouvrage |
»»» poids | integer(int64) | false | none | poids de l'ouvrage, en grammes |
»»» nbPages | string | false | none | nombre de pages |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» epaisseur | number(double) | false | none | épaisseur de l'ouvrage, en centimètres |
»» publics | [object] | false | none | lectorat |
»»» publicId | string | true | none | code du type de public |
»»» libellePublic | string | true | none | description du type de public |
»» flagFiction | boolean | false | none | Indique s'il s'agit d'un ouvrage de fiction ou non. |
»» disponibilite | string | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "manquant", "a-paraitre", "disponible"] |
»» desactive | boolean | true | none | Indique si la notice a existé mais a été désactivée. Toujours à FALSE pour le endpoint /init, parfois à TRUE pour le endpoint /updated. |
»» disponibiliteEtendue | object | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "arret de commercialisation", "ne sera plus distribue", "reimpression en cours", "manque provisoirement", "a-paraitre", "disponible"] |
»»» disponibiliteEtendueId | integer(int64) | true | none | Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 Mapping : disponible 1 a-paraitre 2 reimpression-en-cours 3 manque-provisoirement 4 epuise 5 arret-de-commercialisation 6 ne-sera-plus-distribue 7 a-reparaitre 8 parution-annulee 9 |
»»» disponibiliteEtendueLibelle | string | true | none | Valeur de disponibilité parmi - disponible - a-paraitre - reimpression-en-cours - manque-provisoirement - epuise - arret-de-commercialisation - ne-sera-plus-distribue - a-reparaitre - parution-annulee |
»» eansUtilises | [string] | false | none | EANs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total de notices |
GET-Notices-by-EAN
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/notices/ean/{ean} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/notices/ean/{ean} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notices/ean/{ean}
Notices by EAN endpoint
API to get notices by EAN
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
catalogue | query | string | false | Type de catalogue : livre, film, musique ou jeu-video |
ean | path | string | true | EAN de l'ouvrage recherché |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» notices | [object] | true | none | Liste des notices renvoyées par la requête, une notice regroupe l'ensemble des données commerciales, bibliographiques et de classement |
»» resumeElectre | string | false | none | Résumé Electre SEO |
»» anciennesEditionsEan | [string] | false | none | EANs des précédentes éditions. Cas des ouvrages millésimés (guides touristiques, codes réglementaires |
»» typeProduit | object | false | none | Type de produit de l'article (classification simple: ce support est celui du type de produits proposé sur le portail Electre NG et qui permet de distinguer les types de produits différents d'un livre papier dans une liste de résultat ou dans une notice) Un seul type de produit par article. Ce champ était historiquement appelé "support" en API V3. |
»»» typeProduitId | string | true | none | code du type de produit |
»»» libelleTypeProduit | string | true | none | description du type de produit |
»» flagScolaire | boolean | false | none | Indique si l'ouvrage est un ouvrage scolaire au sens juridique du terme (true) Les livres scolaires font l’objet de dispositions juridiques particulières au regard de la loi sur le prix unique du livre (loi du 10 août 1981) et de la loi sur le droit de prêt (loi du 18 juin 2003). Le décret 2004-922 du 31 août 2004 a reprécisé la définition du livre scolaire pour l’application de ces dispositions. |
»» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
»» catalogue | string | true | none | Ouvrage issu du catalogue : livre Si la valeur donnée est différente des valeurs autorisées, une erreur de validation va être retournée. |
»» autresFormats | [object] | false | none | lien entre papier et formats numériques (référence croisée) |
»»» noticeLieeEan | string | true | none | identifiant de la notice en lien |
»»» formatLivreLie | string | true | none | nom du format (PDF, ePub, papier). Dans le cadre des packs numériques, ce champ contient l'ensemble des formats séparés par des virgules. |
»» mentionsEdition | string | false | none | Mentions d'édition précisant une caractéristique de l'édition (révisée, nouvelle, augmentée...) |
»» dateParution | string | false | none | Date de parution au format YYYY-MM-DD |
»» prixDeLancement | object | false | none | Prix de lancement de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes |
»»»» taxeId | string | true | none | Identifiant la taxe |
»»»» horsTaxe | number(double) | true | none | montant de lancement hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | tva sur le produit |
»»» ttc | number(double) | true | none | montant de lancement TTC |
»»» dateDebut | string | true | none | Début de la période durant laquelle le prix de lancement s'applique |
»»» dateFin | string | true | none | Fin de la période durant laquelle le prix de lancement s'applique |
»» quatriemeDeCouvertureResume | string | false | none | Résumé éditeur issu de la quatrième de couverture; temporairement renseigné par un texte Electre tant que la 4e n'est pas disponible |
»» clilFel | object | false | none | Classification CLIL issue de Dilicom |
»»» clilFelId | string | true | none | code CLIL FEL (Dilicom) |
»»» libelleClilFel | string | true | none | libellé CLIL FEL (Dilicom) |
»» anneeEdition | string | false | none | Année d'édition au format YYYY |
»» quatriemeDeCouverture | string | false | none | Résumé éditeur issu de la quatrième de couverture |
»» languesEcriture | [object] | false | none | Langues dans lesquelles est écrit l'ouvrage. (Plusieurs langue possible). |
»»» codeLangue | string | true | none | none |
»»» libelleLangue | string | true | none | none |
»» biographie | string | false | none | Texte de la biographie (ou des biographies si plusieurs contributeurs) le cas échéant dans plusieurs langues pour certains ouvrages multilingues), issu de la quatrième de couverture. Ce contenu présrente des balises HTML notamment pour séparer les différentes versions linguistiques lorsque les biographies sont multilingues EXEMPLE : 9782908445077 |
»» eansErrones | [string] | false | none | EANs communiqués par erreur par l'éditeur, utile pour la recherche |
»» collections | [object] | false | none | collection d'ouvrages chez un éditeur Ce champ est aussi utilisé pour diffuser les revues |
»»» collectionId | string | true | none | identifiant de la collection |
»»» libelleCollection | string | true | none | libellé de la collection |
»»» issn | string | false | none | code ISSN de la collection |
»»» noDeCollection | string | false | none | numéro de l'ouvrage dans la collection |
»»» sousCollection | object | false | none | sous-collection d'ouvrages chez un éditeur |
»»»» sousCollectionId | string | true | none | identifiant de la sous-collection |
»»»» libelleSousCollection | string | true | none | libellé de la sous-collection |
»»»» issnSousCollection | string | false | none | code ISSN de la sous-collection |
»»»» noDeSousCollection | string | false | none | numéro de l'ouvrage dans la sous-collection |
»»»» sousSousCollection | object | false | none | sous-sous-collection d'ouvrages chez un éditeur |
»»»»» sousSousCollectionId | string | true | none | identifiant de la sous-sous-collection |
»»»»» libelleSousSousCollection | string | true | none | libellé de la sous-sous-collection |
»»»»» issnSousSousCollection | string | true | none | code ISSN de la sous-sous-collection |
»»»»» noDeSousSousCollection | string | true | none | numéro de l'ouvrage dans la sous-sous-collection |
»» descriptionsEbook | object | false | none | caractéristiques d'un livre numérique |
»»» formatEbook | string | true | none | format numérique; en cas de pack numérique, tous les formats du pack sont exposés |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» typeVolume | string | false | none | type de volume |
»»» protectionEbook | string | false | none | type de protection de l'ebook |
»»» droitsEbook | [object] | false | none | droits de l'ebook |
»»»» utilisation | string | true | none | none |
»»»» limitation | string | true | none | none |
»»» resumeEbook | string | false | none | résumé du livre et/ou texte de l'équivalent 4ème de couverture |
»»» poidsEbook | string | false | none | poids en mégaoctets du fichier numérique |
»»» packEbookContenus | [object] | false | none | fourni le détail des informations des différents fichiers d'un pack numérique : EAN de chaque fichier, format, protection, droits, poids... |
»»»» formatEbookContenu | string | true | none | none |
»»»» typeVolume | string | false | none | type de volume |
»»»» poidsEbookContenu | number(double) | false | none | none |
»»»» eanEbookContenu | string | false | none | none |
»»»» venduSeul | boolean | false | none | Indique si le livre numérique dans un format de fichier donné peut être vendu seul |
»»»» nbVolumes | string | false | none | nombre de volumes |
»»»» droitsEbookContenu | [object] | false | none | none |
»»»»» utilisation | string | true | none | none |
»»»»» limitation | string | true | none | none |
»»»» descriptionEbookContenu | string | false | none | none |
»»»» protectionEbookContenu | string | false | none | none |
»» image160pxCouverture | string | false | none | URL de l'imagette desktop de la couverture au format JPG de taille 160 pixels de large |
»» support | object | false | none | Support classification étendue, granularité plus fine que celle du code type de produit : ce support est identique à celui du portail V2 ainsi qu'au support du portail NG. Ce champ était historiquement appelé "support étendu" en API V3. |
»»» supportId | string | true | none | code du support |
»»» libelleSupport | string | true | none | libellé du support |
»» titre | string | true | none | Titre complet de l'ouvrage construit à partir de plusieurs titres |
»» rayonsElectreEtendu | [object] | false | none | classification étendue (env. 750 entrées) |
»»» rayonElectreEtenduId | string | true | none | code rayon Electre, classification étendue |
»»» libelleRayonElectreEtendu | string | true | none | libellé rayon Electre, classification étendue |
»» imageCouverture | string | false | none | URL de l'image de la couverture au format JPG à la taille maximale |
»» isbnsErrones | [string] | false | none | ISBNs communiqués par erreur par l'éditeur, utile pour la recherche |
»» legacyNoticeId | string | true | none | Identifiant de la notice chez Electre utilisé dans les systèmes Legacy V2 et V3. C'est cet ID qui doit être utilisé par tous les système tiers précemment alimentés par les versions V2 et V3 de la base electre. |
»» extraitPlayer | string | false | none | Extrait + player consommés ensemble (URL) |
»» themaQualificatifs | [object] | false | none | Composante qualificatif de la classification internationale Thema |
»»» themaQualifId | string | true | none | code du qualificatif Thema |
»»» libelleThemaQualif | string | true | none | libellé du qualificatif Thema |
»» imagetteCouverture | string | false | none | URL de l'imagette mobile de la couverture au format JPG de taille 80 pixels de large |
»» auteursSecondaires | [object] | false | none | liste des contributeurs secondaires à l'ouvrage |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»»» nom | string | true | none | nom du contributeur |
»»» formebib | string | false | none | forme bibliographique complet du nom du contributeur |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» prenom | string | false | none | prénom du contributeur |
»»» nationalites | [object] | false | none | nationalité(s) du contributeur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» auteurId | string | true | none | none |
»»» typeContribution | string | true | none | Type de contribution secondaire Enumerated values in: ["Traducteur", "Directeur de publication", "Editeur scientifique (ou intellectuel)", "Commentateur de texte", "Inconnu", "Auteur de l’idée originale", "Rédacteur / Rapporteur", "Photographe" "Illustrateur", "Coloriste", "Calligraphe", "Cartographe", "Auteur du matériel d'accompagnement", "Maquettiste", "Préfacier", "Postfacier", "Organisateur d’un congrès", "Organisateur d’une exposition", "Commentateur audio", "Photographe (film)", "Chorégraphe", "Directeur artistique", "Autres", "Collaborateur", "Narrateur", "Chef d'une interprétation musicale", "Soliste vocal", "Soliste instrumental", "Groupe musical", "Chanteur","Acteur", "Danseur", "Autres interprètes", "Directeur de collection", "Fondateur d'une revue, d'une collection"] |
»»» langueTraduction | [object] | false | none | pour les traducteurs, langue d'origine de l'ouvrage |
»»»» codeLangue | string | true | none | none |
»»»» libelleLangue | string | true | none | none |
»» eansJustes | [string] | false | none | EANs corrects |
»» distributeur | object | false | none | Distributeur |
»»» distributeurId | string | true | none | identifiant du distributeur Electre |
»»» distributeurNoticeRef | string | false | none | Référence de la notice chez le distributeur |
»»» globalLocationNumber | integer(int64) | false | none | code distributeur GLN (Global Location Number) |
»»» raisonSociale | string | true | none | raison sociale du distributeur |
»» dewey | [object] | false | none | Classification Dewey |
»»» codeDewey | string | true | none | code Dewey |
»»» libelleDewey | string | true | none | libellé Dewey |
»» editeurs | [object] | true | none | Editeurs |
»»» editeurId | string | true | none | identifiant Electre de l'éditeur |
»»» formeBibEditeur | string | true | none | Forme bibliographique de l'éditeur |
»»» lieuPublication | string | true | none | Ville du lieu d'édition |
»» groupeTitres | object | true | none | Ensemble de titres, sous-titres et mentions associés |
»»» titreRevue | object | false | none | none |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroRevue | string | false | none | none |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»» titresDensemble | [object] | false | none | Type de groupe de titres titre d'ensemble |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroVolume | string | false | none | Les numéros de revues et les numéros de volumes de livres sont envoyés dans ce même champs. NB Tomaison : Les deux notions de "tome" (subdivision littéraire d'un ouvrage) et de "volume" (subdivision physique) ne sont pas distinguées dans la base Electre (depuis 2010). Un ouvrage pourra avoir un n° de volume (en tant que n° de volume physique) et un n° de volume (en tant que tome) Par ailleurs, les deux informations de volumaison et de tomaison n'étant pas systématiquement répertoriées sur la page de titre par les éditeurs, ses informations ne sont pas systèmatiquement intégrées dans la base Electre. Seuls les titres d'ensemble possèdent des n° de volume. |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitre | string | false | none | Sous titre |
»»» titresPrincipaux | [object] | false | none | Type de groupe de titres principaux. Il est possible d'avoir un titre d'ensemble sans titre principal |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»»» titresContenus | [object] | false | none | Titres contenus dans un ouvrage qui comprend plusieurs titres (recueil, intégrale, etc.) |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»» isbnsUtilises | [string] | false | none | ISBNs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
»» source | string | true | none | Source de la notice (electre, btlf, olf, dilicom) Les sources disponibles dépendent de l'abonnement souscrit. |
»» nouvellesEditionsEan | [string] | false | none | Les EANs aux éditions suivantes |
»» coffret | boolean | false | none | none |
»» felLibelleCaisse | string | false | none | Désignation courte du produit (20 caractères) permettant au consommateur de faire le rapprochement entre les articles achetés et les lignes de son ticket de caisse. |
»» extrait | object | false | none | URL de l'extrait fourni par l'éditeur au format epub ou pdf |
»»» extraitUrl | string | false | none | URL de l'extrait au format epub ou pdf |
»»» extraitFormat | string | false | none | format de l'extrait |
»» rayonsElectre | [object] | false | none | classification simple (env. 200 entrées) |
»»» rayonElectreId | string | true | none | code rayon Electre, classification simple |
»»» libelleRayonElectre | string | true | none | libellé rayon Electre, classification simple |
»» series | [object] | false | none | série d'ouvrages chez un éditeur donné |
»»» serieId | string | true | none | identifiant de la série |
»»» titreSerie | string | true | none | titre de la série |
»»» numeroSerie | string | false | none | rang de l'ouvrage dans la série |
»»» serieIssn | string | false | none | N° ISSN de la série |
»» noticeId | string | true | none | Identifiant de la notice chez Electre dans le nouveau référentiel mis en place sur Electre NG. |
»» isbns | [string] | false | none | International Standard Book Number (ISBN 13) |
»» felCodeRetour | integer(int64) | false | none | Code indiquant si cet article peut être ou non retourné. - "retour-possible-selon-CGV" (code retour Dilicom 1) - "retour-interdit" (code retour Dilicom 2) - "retour-interdit-sauf-accord-cial" (code retour Dilicom 3) - "retour-sur-couverture" (code retour Dilicom 5) - "retour-sur-couverture-obligatoire" (code retour Dilicom 6) |
»» eans | [string] | true | none | Identifiants EAN de l'ouvrage (plusieurs EAN possibles) |
»» auteursPrincipaux | [object] | false | none | auteurs principaux de l'ouvrage |
»»» auteurId | string | true | none | identifiant de l'auteur |
»»» nom | string | false | none | nom de l'auteur |
»»» prenom | string | false | none | prénom de l'auteur |
»»» formebib | string | true | none | forme bibliographique du nom de l'auteur + qualificatifs |
»»» typeContribution | string | true | none | Type de contribution principale (Auteur, Adaptateur, Producteur, etc.), Enumerated values in: ["Auteur", "Auteur (photographe)", "Auteur (illustrateur)", "Interviewer", "Personne interviewée", "Auteur du texte", "Auteur originel", "Auteur adapté", "Adaptateur", "Auteur douteux, prétendu", "Auteur (artiste)", "Librettiste", "Parolier", "Compositeur", "Programmeur", "Infographiste", "Scénariste", "Dialoguiste", "Concepteur", "Producteur", "Réalisateur de film"] |
»»» nationalites | [object] | false | none | nationalité(s) de l'auteur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»» themaCategories | [object] | false | none | Composante catégorie de la classification internationale Thema |
»»» themaCategorieId | string | true | none | code de la catégorie Thema |
»»» libelleThemaCategorie | string | true | none | libellé de la catégorie Thema |
»» genres | [object] | false | none | Indexation genre de la base Electre |
»»» genreId | string | true | none | Code pour toute la branche |
»»» libelleGenre | string | true | none | Libellé de toute la branche |
»» isbnsJustes | [string] | false | none | ISBNs corrects |
»» felImpressionDemande | boolean | false | none | désigne les articles en impression à la demande. L'IAD est aussi un type de produit envoyé dans le champ "support" |
»» prix | object | true | none | Prix de vente de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»» ttc | number(double) | true | none | Montant TTC |
»» theme | object | false | none | Indexation Theme de la base Electre |
»»» themeId | string | true | none | Code pour toute la branche |
»»» libelleTheme | string | true | none | Libellé de toute la branche |
»» descriptionPhysique | object | false | none | caractéristiques physiques de l'article |
»»» hauteur | number(double) | false | none | hauteur de l'ouvrage, en centimètres |
»»» duree | string | false | none | durée de l'ouvrage |
»»» largeur | number(double) | false | none | largeur de l'ouvrage, en centimètres |
»»» typeVolume | string | false | none | type de volume |
»»» mentionIllustrations | string | false | none | types d'illustrations (illustrations en couleur, en noir et blanc) |
»»» reliure | string | false | none | type de reliure de l'ouvrage |
»»» poids | integer(int64) | false | none | poids de l'ouvrage, en grammes |
»»» nbPages | string | false | none | nombre de pages |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» epaisseur | number(double) | false | none | épaisseur de l'ouvrage, en centimètres |
»» mesChampsExtras | object | false | none | none |
»»» stock | integer(int64) | false | none | none |
»»» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»»»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
»»» populariteOrganisation | integer(int64) | false | none | La popularité organisation, ajoutée à la popularité Electre pour augmenter le score lors d'une recherche. Doit être positive. |
»»» champLibre10 | string | false | none | champ libre 10, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre2 | string | false | none | champ libre 2, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre1 | string | false | none | champ libre 1, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre7 | string | false | none | champ libre 7, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» delaiLivraison | string | false | none | none |
»»» champLibre8 | string | false | none | champ libre 8, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre6 | string | false | none | champ libre 6, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre4 | string | false | none | champ libre 4, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» nombreVues | integer(int64) | false | none | none |
»»» prixPromo | object | false | none | Prix de vente de l'ouvrage |
»»»» devise | string | true | none | Code ISO de la devise |
»»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»»» ttc | number(double) | true | none | Montant TTC |
»»» champLibre5 | string | false | none | champ libre 5, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» prix | object | false | none | Prix de vente de l'ouvrage |
»»»» devise | string | true | none | Code ISO de la devise |
»»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»»» ttc | number(double) | true | none | Montant TTC |
»»» ventes | integer(int64) | false | none | none |
»»» champLibre9 | string | false | none | champ libre 9, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre3 | string | false | none | champ libre 3, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»» publics | [object] | false | none | lectorat |
»»» publicId | string | true | none | code du type de public |
»»» libellePublic | string | true | none | description du type de public |
»» flagFiction | boolean | false | none | Indique s'il s'agit d'un ouvrage de fiction ou non. |
»» disponibilite | string | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "manquant", "a-paraitre", "disponible"] |
»» desactive | boolean | true | none | Indique si la notice a existé mais a été désactivée. Toujours à FALSE pour le endpoint /init, parfois à TRUE pour le endpoint /updated. |
»» disponibiliteEtendue | object | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "arret de commercialisation", "ne sera plus distribue", "reimpression en cours", "manque provisoirement", "a-paraitre", "disponible"] |
»»» disponibiliteEtendueId | integer(int64) | true | none | Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 Mapping : disponible 1 a-paraitre 2 reimpression-en-cours 3 manque-provisoirement 4 epuise 5 arret-de-commercialisation 6 ne-sera-plus-distribue 7 a-reparaitre 8 parution-annulee 9 |
»»» disponibiliteEtendueLibelle | string | true | none | Valeur de disponibilité parmi - disponible - a-paraitre - reimpression-en-cours - manque-provisoirement - epuise - arret-de-commercialisation - ne-sera-plus-distribue - a-reparaitre - parution-annulee |
»» eansUtilises | [string] | false | none | EANs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
» total | integer(int64) | true | none | Nombre total de notices |
Recherche
External API endpoints to search for notices
GET-Notices-Search
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/notices/search \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/notices/search HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/notices/search',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/notices/search',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/notices/search', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/notices/search', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/notices/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/notices/search", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notices/search
Search Notices endpoint
Notices search API engine
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
filtres.montant.min | query | number | false | Filtre montant : borne inférieure du curseur. |
filtres.rayons-client | query | string | false | Filtre facette rayon client. Ce paramètre peut être répété pour filtrer par plusieurs rayons différents. |
id.collection | query | string | false | Identifiant collection utilisé pour le rebond |
catalogue | query | string | false | Filtre par catalogue (livres, musique, films). A venir... |
offset | query | integer | false | Offset pour la page appelée |
filtres.date.min | query | string | false | Filtre date : borne inférieure du curseur. Les formats de date acceptés sont : |
q | query | string | false | Recherche libre sur les champs titre, auteur, éditeur, collection, ISBN, EAN, avec un OU logique. |
filtres.montant.max | query | number | false | Filtre montant : borne supérieure du curseur. |
sort.order | query | string | false | Sens du tri. Exemple : "asc", "desc" |
id.rayon-client | query | string | false | Identifiant rayon client utilisé pour le rebond |
filtres.disponibilite | query | string | false | Filtre facette disponibilité. Ce paramètre peut être répété pour filtrer par plusieurs disponiblités différentes. |
q.ean-isbn | query | string | false | Recherche ciblée EAN/ISBN (les champs d'une recherche ciblée sont composés avec l'opérateur logique ET) |
q.rayon | query | string | false | Recherche ciblée rayon electre etendu, recherche par code de rayon. Recherche effectuée sur le rayon et ses enfants. (les champs d'une recherche ciblée sont composés avec l'opérateur logique ET) |
q.titre | query | string | false | Recherche ciblée titre (les champs d'une recherche ciblée sont composés avec l'opérateur logique ET) |
q.auteur | query | string | false | Recherche ciblée auteur (les champs d'une recherche ciblée sont composés avec l'opérateur logique ET) |
limit | query | integer | false | Quantité maximale de notices par page |
q.editeur | query | string | false | Recherche ciblée éditeur (les champs d'une recherche ciblée sont composés avec l'opérateur logique ET) |
filtres.type-produit | query | string | false | Filtre facette type produit. Ce paramètre peut être répété pour filtrer par plusieurs types produits différents. |
id.rayon-electre-etendu | query | string | false | Identifiant rayon electre étendu utilisé pour le rebond |
filtres.rayon-electre | query | string | false | Filtre facette rayon electre. Ce paramètre peut être répété pour filtrer par plusieurs rayons différents. |
filtres.auteurs | query | string | false | Filtre facette auteurs. Ce paramètre peut être répété pour filtrer par plusieurs auteurs différents. |
filtres.editeurs | query | string | false | Filtre facette éditeurs. Ce paramètre peut être répété pour filtrer par plusieurs éditeurs différents. |
filtres.date.max | query | string | false | Filtre date : borne supérieure du curseur. Les formats de date acceptés sont : |
filtres.series | query | string | false | Filtre facette séries. Ce paramètre peut être répété pour filtrer par plusieurs séries différentes. |
id.auteur | query | string | false | Identifiant auteur utilisé pour le rebond |
filtres.collections | query | string | false | Filtre facette collections. Ce paramètre peut être répété pour filtrer par plusieurs collections différentes. |
q.collection | query | string | false | Recherche ciblée collection (les champs d'une recherche ciblée sont composés avec l'opérateur logique ET) |
sort.field | query | string | false | Champ sur lequel faire le tri. Exemple : "score”, “titre”, “auteur”, “editeur”, “date-parution”, “montant" |
filtres.rayon-electre-etendu | query | string | false | Filtre facette rayon electre étendu. Ce paramètre peut être répété pour filtrer par plusieurs rayons différents. |
facets | query | boolean | false | Retourne les facettes sur la recherche. true par défaut |
id.serie | query | string | false | Identifiant série utilisé pour le rebond |
id.editeur | query | string | false | Identifiant éditeur utilisé pour le rebond |
Detailed descriptions
filtres.date.min: Filtre date : borne inférieure du curseur. Les formats de date acceptés sont :
- "dd-MM-yyyy"
- "yyyy-MM-dd"
- "dd/MM/yyyy"
- "yyyy/MM/dd"
- "yyyy-MM-dd'T'HH:mm"
- "yyyy-MM-dd'T'HH:mm:ss"
filtres.date.max: Filtre date : borne supérieure du curseur. Les formats de date acceptés sont :
- "dd-MM-yyyy"
- "yyyy-MM-dd"
- "dd/MM/yyyy"
- "yyyy/MM/dd"
- "yyyy-MM-dd'T'HH:mm"
- "yyyy-MM-dd'T'HH:mm:ss"
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» _links | object | true | none | Suggestion de liens pour affiner la recherche. |
»» q | object | true | none | Suggestion de lien pour la recherche libre. |
»»» value | string | true | none | Valeur du paramètre 'q' pour une recherche libre |
»»» href | string | true | none | Valeur du lien pour une recherche libre. |
»» q.titre | object | true | none | Suggestion de lien pour la recherche ciblée titre. |
»»» value | string | true | none | Valeur du paramètre 'q.titre' pour une recherche ciblée titre |
»»» href | string | true | none | Valeur du lien pour une recherche ciblée titre. |
»» q.auteur | object | true | none | Suggestion de lien pour la recherche ciblée auteur. |
»»» value | string | true | none | Valeur du paramètre 'q.auteur' pour une recherche ciblée auteur. |
»»» href | string | true | none | Valeur du lien pour une recherche ciblée auteur. |
»» q.editeur | object | true | none | Suggestion de lien pour la recherche ciblée éditeur. |
»»» value | string | true | none | Valeur du paramètre 'q.editeur' pour une recherche ciblée éditeur. |
»»» href | string | true | none | Valeur du lien pour une recherche ciblée éditeur. |
»» self | object | true | none | Lien avec les différents paramètres qui ont mené à la réponse courante. |
»»» href | string | true | none | Valeur du lien. |
»» date | object | true | none | Dates de parution min et max pour la recherche courante. |
»»» min | string | true | none | Date de parution min, au format dd/MM/yyyy |
»»» max | string | true | none | Date de parution max au format dd/MM/yyyy |
»»» href | string | true | none | Lien de suggestion pour filtrer par curseur de dates. |
»» q.collection | object | true | none | Suggestion de lien pour la recherche ciblée collection. |
»»» value | string | true | none | Valeur du paramètre 'q.collection' pour une recherche ciblée collection. |
»»» href | string | true | none | Valeur du lien pour une recherche ciblée collection. |
»» price | object | true | none | Montant min et max pour la recherche courante. |
»»» min | integer(int64) | true | none | Montant min. |
»»» max | integer(int64) | true | none | Montant max. |
»»» href | string | true | none | Lien de suggestion pour filtrer par curseur de prix. |
»» sorts | [object] | true | none | Liste des tris possibles. |
»»» field | string | true | none | Champ sur lequel faire le tri. |
»»» order | string | false | none | Sens du tri, ascendant ou descendant, sauf pour le champs score. |
»»» selected | boolean | false | none | True, si le tri courant correspond à ces valeurs de tri. |
»»» href | string | true | none | Lien de suggestion pour ces valeurs de tri. |
» facets | object | false | none | Les facettes correspondant à la recherche en cours. |
»» rayons-client | [object] | true | none | Liste des valeurs pour la facette rayons client. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
»» rayon-electre | [object] | true | none | Liste des valeurs pour la facette rayon electre. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
»» type-produit | [object] | true | none | Liste des valeurs pour la facette type produit. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
»» collections | [object] | true | none | Liste des valeurs pour la facette collection. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
»» editeurs | [object] | true | none | Liste des valeurs pour la facette éditeur. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
»» series | [object] | true | none | Liste des valeurs pour la facette série. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
»» auteur | [object] | true | none | Liste des valeurs pour la facette auteur. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
»» disponibilite | [object] | true | none | Liste des valeurs pour la facette disponibilité. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
»» rayon-electre-etendu | [object] | true | none | Liste des valeurs pour la facette rayon electre étendu. |
»»» libelle | string | true | none | Valeur de la facette. |
»»» filtre | string | true | none | Valeur à utiliser dans le filtre associé |
»»» selected | boolean | false | none | Indique si la valeur est déjà dans les filtres de la requête |
»»» occurence | integer(int64) | true | none | Nombre d'occurence de la valeur de facette. |
» limit | integer(int64) | true | none | Quantité maximale de notices par page tel que passé en paramètre |
» notices | [object] | true | none | Liste des notices renvoyées par la requête, une notice regroupe l'ensemble des données commerciales, bibliographiques et de classement |
»» resumeElectre | string | false | none | Résumé Electre SEO |
»» anciennesEditionsEan | [string] | false | none | EANs des précédentes éditions. Cas des ouvrages millésimés (guides touristiques, codes réglementaires |
»» typeProduit | object | false | none | Type de produit de l'article (classification simple: ce support est celui du type de produits proposé sur le portail Electre NG et qui permet de distinguer les types de produits différents d'un livre papier dans une liste de résultat ou dans une notice) Un seul type de produit par article. Ce champ était historiquement appelé "support" en API V3. |
»»» typeProduitId | string | true | none | code du type de produit |
»»» libelleTypeProduit | string | true | none | description du type de produit |
»» flagScolaire | boolean | false | none | Indique si l'ouvrage est un ouvrage scolaire au sens juridique du terme (true) Les livres scolaires font l’objet de dispositions juridiques particulières au regard de la loi sur le prix unique du livre (loi du 10 août 1981) et de la loi sur le droit de prêt (loi du 18 juin 2003). Le décret 2004-922 du 31 août 2004 a reprécisé la définition du livre scolaire pour l’application de ces dispositions. |
»» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
»»» rebondRayonClient | string | false | none | Rebond rayon client. Uniquement pour les rayons web (usageRayonId = web) |
»» catalogue | string | true | none | Ouvrage issu du catalogue : livre Si la valeur donnée est différente des valeurs autorisées, une erreur de validation va être retournée. |
»» autresFormats | [object] | false | none | lien entre papier et formats numériques (référence croisée) |
»»» noticeLieeEan | string | true | none | identifiant de la notice en lien |
»»» formatLivreLie | string | true | none | nom du format (PDF, ePub, papier). Dans le cadre des packs numériques, ce champ contient l'ensemble des formats séparés par des virgules. |
»» mentionsEdition | string | false | none | Mentions d'édition précisant une caractéristique de l'édition (révisée, nouvelle, augmentée...) |
»» dateParution | string | false | none | Date de parution au format YYYY-MM-DD |
»» prixDeLancement | object | false | none | Prix de lancement de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes |
»»»» taxeId | string | true | none | Identifiant la taxe |
»»»» horsTaxe | number(double) | true | none | montant de lancement hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | tva sur le produit |
»»» ttc | number(double) | true | none | montant de lancement TTC |
»»» dateDebut | string | true | none | Début de la période durant laquelle le prix de lancement s'applique |
»»» dateFin | string | true | none | Fin de la période durant laquelle le prix de lancement s'applique |
»» quatriemeDeCouvertureResume | string | false | none | Résumé éditeur issu de la quatrième de couverture; temporairement renseigné par un texte Electre tant que la 4e n'est pas disponible |
»» clilFel | object | false | none | Classification CLIL issue de Dilicom |
»»» clilFelId | string | true | none | code CLIL FEL (Dilicom) |
»»» libelleClilFel | string | true | none | libellé CLIL FEL (Dilicom) |
»» anneeEdition | string | false | none | Année d'édition au format YYYY |
»» quatriemeDeCouverture | string | false | none | Résumé éditeur issu de la quatrième de couverture |
»» languesEcriture | [object] | false | none | Langues dans lesquelles est écrit l'ouvrage. (Plusieurs langue possible). |
»»» codeLangue | string | true | none | none |
»»» libelleLangue | string | true | none | none |
»» biographie | string | false | none | Texte de la biographie (ou des biographies si plusieurs contributeurs) le cas échéant dans plusieurs langues pour certains ouvrages multilingues), issu de la quatrième de couverture. Ce contenu présrente des balises HTML notamment pour séparer les différentes versions linguistiques lorsque les biographies sont multilingues EXEMPLE : 9782908445077 |
»» eansErrones | [string] | false | none | EANs communiqués par erreur par l'éditeur, utile pour la recherche |
»» collections | [object] | false | none | collection d'ouvrages chez un éditeur Ce champ est aussi utilisé pour diffuser les revues |
»»» collectionId | string | true | none | identifiant de la collection |
»»» libelleCollection | string | true | none | libellé de la collection |
»»» issn | string | false | none | code ISSN de la collection |
»»» noDeCollection | string | false | none | numéro de l'ouvrage dans la collection |
»»» rebondCollection | string | true | none | url du rebond collection |
»»» sousCollection | object | false | none | sous-collection d'ouvrages chez un éditeur |
»»»» sousCollectionId | string | true | none | identifiant de la sous-collection |
»»»» libelleSousCollection | string | true | none | libellé de la sous-collection |
»»»» issnSousCollection | string | false | none | code ISSN de la sous-collection |
»»»» noDeSousCollection | string | false | none | numéro de l'ouvrage dans la sous-collection |
»»»» sousSousCollection | object | false | none | sous-sous-collection d'ouvrages chez un éditeur |
»»»»» sousSousCollectionId | string | true | none | identifiant de la sous-sous-collection |
»»»»» libelleSousSousCollection | string | true | none | libellé de la sous-sous-collection |
»»»»» issnSousSousCollection | string | true | none | code ISSN de la sous-sous-collection |
»»»»» noDeSousSousCollection | string | true | none | numéro de l'ouvrage dans la sous-sous-collection |
»» descriptionsEbook | object | false | none | caractéristiques d'un livre numérique |
»»» formatEbook | string | true | none | format numérique; en cas de pack numérique, tous les formats du pack sont exposés |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» typeVolume | string | false | none | type de volume |
»»» protectionEbook | string | false | none | type de protection de l'ebook |
»»» droitsEbook | [object] | false | none | droits de l'ebook |
»»»» utilisation | string | true | none | none |
»»»» limitation | string | true | none | none |
»»» resumeEbook | string | false | none | résumé du livre et/ou texte de l'équivalent 4ème de couverture |
»»» poidsEbook | string | false | none | poids en mégaoctets du fichier numérique |
»»» packEbookContenus | [object] | false | none | fourni le détail des informations des différents fichiers d'un pack numérique : EAN de chaque fichier, format, protection, droits, poids... |
»»»» formatEbookContenu | string | true | none | none |
»»»» typeVolume | string | false | none | type de volume |
»»»» poidsEbookContenu | number(double) | false | none | none |
»»»» eanEbookContenu | string | false | none | none |
»»»» venduSeul | boolean | false | none | Indique si le livre numérique dans un format de fichier donné peut être vendu seul |
»»»» nbVolumes | string | false | none | nombre de volumes |
»»»» droitsEbookContenu | [object] | false | none | none |
»»»»» utilisation | string | true | none | none |
»»»»» limitation | string | true | none | none |
»»»» descriptionEbookContenu | string | false | none | none |
»»»» protectionEbookContenu | string | false | none | none |
»» image160pxCouverture | string | false | none | URL de l'imagette desktop de la couverture au format JPG de taille 160 pixels de large |
»» support | object | false | none | Support classification étendue, granularité plus fine que celle du code type de produit : ce support est identique à celui du portail V2 ainsi qu'au support du portail NG. Ce champ était historiquement appelé "support étendu" en API V3. |
»»» supportId | string | true | none | code du support |
»»» libelleSupport | string | true | none | libellé du support |
»» titre | string | true | none | Titre complet de l'ouvrage construit à partir de plusieurs titres |
»» rayonsElectreEtendu | [object] | false | none | classification étendue (env. 750 entrées) |
»»» rayonElectreEtenduId | string | true | none | code rayon Electre, classification étendue |
»»» libelleRayonElectreEtendu | string | true | none | libellé rayon Electre, classification étendue |
»»» rebondRayonElectreEtendu | string | true | none | url du rebond rayon electre étendu |
»» imageCouverture | string | false | none | URL de l'image de la couverture au format JPG à la taille maximale |
»» isbnsErrones | [string] | false | none | ISBNs communiqués par erreur par l'éditeur, utile pour la recherche |
»» legacyNoticeId | string | true | none | Identifiant de la notice chez Electre utilisé dans les systèmes Legacy V2 et V3. C'est cet ID qui doit être utilisé par tous les système tiers précemment alimentés par les versions V2 et V3 de la base electre. |
»» extraitPlayer | string | false | none | Extrait + player consommés ensemble (URL) |
»» themaQualificatifs | [object] | false | none | Composante qualificatif de la classification internationale Thema |
»»» themaQualifId | string | true | none | code du qualificatif Thema |
»»» libelleThemaQualif | string | true | none | libellé du qualificatif Thema |
»» imagetteCouverture | string | false | none | URL de l'imagette mobile de la couverture au format JPG de taille 80 pixels de large |
»» auteursSecondaires | [object] | false | none | liste des contributeurs secondaires à l'ouvrage |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»»» nom | string | true | none | nom du contributeur |
»»» rebondAuteur | string | true | none | url du rebond auteur |
»»» formebib | string | false | none | forme bibliographique complet du nom du contributeur |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» prenom | string | false | none | prénom du contributeur |
»»» nationalites | [object] | false | none | nationalité(s) du contributeur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» auteurId | string | true | none | none |
»»» typeContribution | string | true | none | Type de contribution secondaire Enumerated values in: ["Traducteur", "Directeur de publication", "Editeur scientifique (ou intellectuel)", "Commentateur de texte", "Inconnu", "Auteur de l’idée originale", "Rédacteur / Rapporteur", "Photographe" "Illustrateur", "Coloriste", "Calligraphe", "Cartographe", "Auteur du matériel d'accompagnement", "Maquettiste", "Préfacier", "Postfacier", "Organisateur d’un congrès", "Organisateur d’une exposition", "Commentateur audio", "Photographe (film)", "Chorégraphe", "Directeur artistique", "Autres", "Collaborateur", "Narrateur", "Chef d'une interprétation musicale", "Soliste vocal", "Soliste instrumental", "Groupe musical", "Chanteur","Acteur", "Danseur", "Autres interprètes", "Directeur de collection", "Fondateur d'une revue, d'une collection"] |
»»» langueTraduction | [object] | false | none | pour les traducteurs, langue d'origine de l'ouvrage |
»»»» codeLangue | string | true | none | none |
»»»» libelleLangue | string | true | none | none |
»» eansJustes | [string] | false | none | EANs corrects |
»» distributeur | object | false | none | Distributeur |
»»» distributeurId | string | true | none | identifiant du distributeur Electre |
»»» distributeurNoticeRef | string | false | none | Référence de la notice chez le distributeur |
»»» globalLocationNumber | integer(int64) | false | none | code distributeur GLN (Global Location Number) |
»»» raisonSociale | string | true | none | raison sociale du distributeur |
»» dewey | [object] | false | none | Classification Dewey |
»»» codeDewey | string | true | none | code Dewey |
»»» libelleDewey | string | true | none | libellé Dewey |
»» editeurs | [object] | true | none | Editeurs |
»»» editeurId | string | true | none | identifiant Electre de l'éditeur |
»»» formeBibEditeur | string | true | none | Forme bibliographique de l'éditeur |
»»» lieuPublication | string | true | none | Ville du lieu d'édition |
»»» rebondEditeur | string | true | none | url du rebond éditeur |
»» groupeTitres | object | true | none | Ensemble de titres, sous-titres et mentions associés |
»»» titreRevue | object | false | none | none |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroRevue | string | false | none | none |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»» titresDensemble | [object] | false | none | Type de groupe de titres titre d'ensemble |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» numeroVolume | string | false | none | Les numéros de revues et les numéros de volumes de livres sont envoyés dans ce même champs. NB Tomaison : Les deux notions de "tome" (subdivision littéraire d'un ouvrage) et de "volume" (subdivision physique) ne sont pas distinguées dans la base Electre (depuis 2010). Un ouvrage pourra avoir un n° de volume (en tant que n° de volume physique) et un n° de volume (en tant que tome) Par ailleurs, les deux informations de volumaison et de tomaison n'étant pas systématiquement répertoriées sur la page de titre par les éditeurs, ses informations ne sont pas systèmatiquement intégrées dans la base Electre. Seuls les titres d'ensemble possèdent des n° de volume. |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitre | string | false | none | Sous titre |
»»» titresPrincipaux | [object] | false | none | Type de groupe de titres principaux. Il est possible d'avoir un titre d'ensemble sans titre principal |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»»» titresContenus | [object] | false | none | Titres contenus dans un ouvrage qui comprend plusieurs titres (recueil, intégrale, etc.) |
»»»» mentions | [string] | false | none | Mentions de responsabilité : type de contribution, préfaciers, traducteurs |
»»»» titres | [object] | true | none | none |
»»»»» typeTitre | string | true | none | Type de titre : titre simple, titres parallèles, titres simple suivi de, ou précédé de, titres contenus...(un titre simple est au minimum fourni) |
»»»»» oeuvreId | string | false | none | Identifiant permettant le rebond vers l'œuvre de référence : rebond titre et non l'oeuvre constellation |
»»»»» libelle | string | true | none | Texte du titre |
»»»»» sousTitres | [string] | false | none | Sous titres |
»» isbnsUtilises | [string] | false | none | ISBNs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
»» source | string | true | none | Source de la notice (electre, btlf, olf, dilicom) Les sources disponibles dépendent de l'abonnement souscrit. |
»» nouvellesEditionsEan | [string] | false | none | Les EANs aux éditions suivantes |
»» coffret | boolean | false | none | none |
»» felLibelleCaisse | string | false | none | Désignation courte du produit (20 caractères) permettant au consommateur de faire le rapprochement entre les articles achetés et les lignes de son ticket de caisse. |
»» extrait | object | false | none | URL de l'extrait fourni par l'éditeur au format epub ou pdf |
»»» extraitUrl | string | false | none | URL de l'extrait au format epub ou pdf |
»»» extraitFormat | string | false | none | format de l'extrait |
»» rayonsElectre | [object] | false | none | classification simple (env. 200 entrées) |
»»» rayonElectreId | string | true | none | code rayon Electre, classification simple |
»»» libelleRayonElectre | string | true | none | libellé rayon Electre, classification simple |
»» series | [object] | false | none | série d'ouvrages chez un éditeur donné |
»»» serieId | string | true | none | identifiant de la série |
»»» titreSerie | string | true | none | titre de la série |
»»» numeroSerie | string | false | none | rang de l'ouvrage dans la série |
»»» serieIssn | string | false | none | N° ISSN de la série |
»»» rebondSerie | string | true | none | url du rebond série |
»» noticeId | string | true | none | Identifiant de la notice chez Electre dans le nouveau référentiel mis en place sur Electre NG. |
»» isbns | [string] | false | none | International Standard Book Number (ISBN 13) |
»» felCodeRetour | integer(int64) | false | none | Code indiquant si cet article peut être ou non retourné. - "retour-possible-selon-CGV" (code retour Dilicom 1) - "retour-interdit" (code retour Dilicom 2) - "retour-interdit-sauf-accord-cial" (code retour Dilicom 3) - "retour-sur-couverture" (code retour Dilicom 5) - "retour-sur-couverture-obligatoire" (code retour Dilicom 6) |
»» eans | [string] | true | none | Identifiants EAN de l'ouvrage (plusieurs EAN possibles) |
»» auteursPrincipaux | [object] | false | none | auteurs principaux de l'ouvrage |
»»» idBnf | integer(int64) | false | none | identifiant BNF de l'auteur |
»»» nom | string | false | none | nom de l'auteur |
»»» rebondAuteur | string | true | none | url du rebond auteur |
»»» formebib | string | true | none | forme bibliographique du nom de l'auteur + qualificatifs |
»»» qualificatifs | [string] | false | none | date de naissance, date de mort, titre nobiliaire... |
»»» prenom | string | false | none | prénom de l'auteur |
»»» nationalites | [object] | false | none | nationalité(s) de l'auteur |
»»»» nationaliteCode | string | true | none | code ISO à deux lettres de la nationalité |
»»»» nationaliteLibelle | string | true | none | Libelllé en Français de la nationalité |
»»» auteurId | string | true | none | identifiant de l'auteur |
»»» typeContribution | string | true | none | Type de contribution principale (Auteur, Adaptateur, Producteur, etc.), Enumerated values in: ["Auteur", "Auteur (photographe)", "Auteur (illustrateur)", "Interviewer", "Personne interviewée", "Auteur du texte", "Auteur originel", "Auteur adapté", "Adaptateur", "Auteur douteux, prétendu", "Auteur (artiste)", "Librettiste", "Parolier", "Compositeur", "Programmeur", "Infographiste", "Scénariste", "Dialoguiste", "Concepteur", "Producteur", "Réalisateur de film"] |
»» themaCategories | [object] | false | none | Composante catégorie de la classification internationale Thema |
»»» themaCategorieId | string | true | none | code de la catégorie Thema |
»»» libelleThemaCategorie | string | true | none | libellé de la catégorie Thema |
»» genres | [object] | false | none | Indexation genre de la base Electre |
»»» genreId | string | true | none | Code pour toute la branche |
»»» libelleGenre | string | true | none | Libellé de toute la branche |
»» isbnsJustes | [string] | false | none | ISBNs corrects |
»» felImpressionDemande | boolean | false | none | désigne les articles en impression à la demande. L'IAD est aussi un type de produit envoyé dans le champ "support" |
»» prix | object | true | none | Prix de vente de l'ouvrage |
»»» devise | string | true | none | Code ISO de la devise |
»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»» ttc | number(double) | true | none | Montant TTC |
»» theme | object | false | none | Indexation Theme de la base Electre |
»»» themeId | string | true | none | Code pour toute la branche |
»»» libelleTheme | string | true | none | Libellé de toute la branche |
»» descriptionPhysique | object | false | none | caractéristiques physiques de l'article |
»»» hauteur | number(double) | false | none | hauteur de l'ouvrage, en centimètres |
»»» duree | string | false | none | durée de l'ouvrage |
»»» largeur | number(double) | false | none | largeur de l'ouvrage, en centimètres |
»»» typeVolume | string | false | none | type de volume |
»»» mentionIllustrations | string | false | none | types d'illustrations (illustrations en couleur, en noir et blanc) |
»»» reliure | string | false | none | type de reliure de l'ouvrage |
»»» poids | integer(int64) | false | none | poids de l'ouvrage, en grammes |
»»» nbPages | string | false | none | nombre de pages |
»»» nbVolumes | integer(int64) | false | none | nombre de volumes |
»»» epaisseur | number(double) | false | none | épaisseur de l'ouvrage, en centimètres |
»» mesChampsExtras | object | false | none | none |
»»» stock | integer(int64) | false | none | none |
»»» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»»»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»»»» rayonClientId | string | true | none | code du rayon dans la classification |
»»»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
»»» populariteOrganisation | integer(int64) | false | none | La popularité organisation, ajoutée à la popularité Electre pour augmenter le score lors d'une recherche. Doit être positive. |
»»» champLibre10 | string | false | none | champ libre 10, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre2 | string | false | none | champ libre 2, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre1 | string | false | none | champ libre 1, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre7 | string | false | none | champ libre 7, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» delaiLivraison | string | false | none | none |
»»» champLibre8 | string | false | none | champ libre 8, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre6 | string | false | none | champ libre 6, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre4 | string | false | none | champ libre 4, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» nombreVues | integer(int64) | false | none | none |
»»» prixPromo | object | false | none | Prix de vente de l'ouvrage |
»»»» devise | string | true | none | Code ISO de la devise |
»»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»»» ttc | number(double) | true | none | Montant TTC |
»»» champLibre5 | string | false | none | champ libre 5, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» prix | object | false | none | Prix de vente de l'ouvrage |
»»»» devise | string | true | none | Code ISO de la devise |
»»»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»»»» ttc | number(double) | true | none | Montant TTC |
»»» ventes | integer(int64) | false | none | none |
»»» champLibre9 | string | false | none | champ libre 9, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»»» champLibre3 | string | false | none | champ libre 3, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
»» publics | [object] | false | none | lectorat |
»»» publicId | string | true | none | code du type de public |
»»» libellePublic | string | true | none | description du type de public |
»» flagFiction | boolean | false | none | Indique s'il s'agit d'un ouvrage de fiction ou non. |
»» disponibilite | string | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "manquant", "a-paraitre", "disponible"] |
»» desactive | boolean | true | none | Indique si la notice a existé mais a été désactivée. Toujours à FALSE pour le endpoint /init, parfois à TRUE pour le endpoint /updated. |
»» disponibiliteEtendue | object | true | none | Disponibilité de l'ouvrage, Enumerated values in: ["epuise", "arret de commercialisation", "ne sera plus distribue", "reimpression en cours", "manque provisoirement", "a-paraitre", "disponible"] |
»»» disponibiliteEtendueId | integer(int64) | true | none | Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 Mapping : disponible 1 a-paraitre 2 reimpression-en-cours 3 manque-provisoirement 4 epuise 5 arret-de-commercialisation 6 ne-sera-plus-distribue 7 a-reparaitre 8 parution-annulee 9 |
»»» disponibiliteEtendueLibelle | string | true | none | Valeur de disponibilité parmi - disponible - a-paraitre - reimpression-en-cours - manque-provisoirement - epuise - arret-de-commercialisation - ne-sera-plus-distribue - a-reparaitre - parution-annulee |
»» eansUtilises | [string] | false | none | EANs utilisés par erreur, par l'éditeur, pour codifier un ou plusieurs articles distincts |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total de notices |
GET-Notices-Suggestions
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/notices/suggestions?q= \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/notices/suggestions?q= HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/notices/suggestions?q=',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/notices/suggestions',
params: {
'q' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/notices/suggestions', params={
'q': ''
}, headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/notices/suggestions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/notices/suggestions?q=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/notices/suggestions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notices/suggestions
Notice suggestions endpoint
API to fetch notice suggestions (related to "/notices/search" endpoint and requires the proper permissions in your business subscription)
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale de résultats par page |
q | query | string | true | Recherche sur les champs titre, auteur, éditeur, collection, avec un ET logique. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» suggestions | [object] | true | none | Liste des suggestions renvoyées par la requête |
»» suggestion | string | true | none | Suggestion précédée du nom de l'index pour lequel la suggestion est proposée |
»» surlignage | string | true | none | Suggestion avec le terme retrouvé dans une balise |
»» recherche | string | true | none | Url permettant de relancer une recherche sur le terme retrouvé |
» total | integer(int64) | true | none | Nombre total de suggestions |
Périmètres Pilotés
External API endpoints for managing perimeter
GET
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /perimetres/comptes/{username}
Endpoint pour recuperer le perimetre pilotes du compte
Recupere le périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
username | path | string | true | le username du compte pour lequel on souhaite récupérer le périmètre piloté |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» totalAuteursExclus | integer(int64) | false | none | Nombre total d'auteurs exclus pour ce périmètre |
» totalAuteursInclus | integer(int64) | false | none | Nombre total d'auteurs inclus pour ce périmètre |
» totalEansExclus | integer(int64) | false | none | Nombre total d'eans exclus pour ce périmètre |
» totalEansInclus | integer(int64) | false | none | Nombre total d'eans inclus pour ce périmètre |
» totalEditeursExclus | integer(int64) | false | none | Nombre total d'éditeurs exclus pour ce périmètre |
» totalEditeursInclus | integer(int64) | false | none | Nombre total d'éditeurs inclus pour ce périmètre |
Périmètres Pilotés par inclusion
External API endpoints for managing perimeter by inclusion list
PUT-Inclusion-Editeur
Code samples
# You can also use wget
curl -X PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /perimetres/comptes/{username}/inclusions/editeurs/{editeurId}
Endpoint pour inclure un editeur dans le perimetre pilote du compte
Inclus l'editeur dénoté par son identifiant au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
editeurId | path | string | true | identifiant de l'éditeur à inclure (tel que retourné par les ressources /notice/xxx) |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
DELETE-Inclusion-Editeur
Code samples
# You can also use wget
curl -X DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs/{editeurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /perimetres/comptes/{username}/inclusions/editeurs/{editeurId}
Endpoint pour supprimer l'inclusion d'un editeur dans le perimetre pilote du compte
Supprime l'inclusion de l'editeur dénotée par son identifiant au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
editeurId | path | string | true | identifiant de l'éditeur à retirer de l'inclusion (tel que retourné par les ressources /notice/xxx) |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
GET-Inclusion-Auteur
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /perimetres/comptes/{username}/inclusions/auteurs
Endpoint de consultation des auteurs inclus dans le perimetre pilote du compte
Consultation paginée des auteurs dans le périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale d'auteur par page |
offset | query | integer | false | Offset pour la page appelée |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» auteurs | string | true | none | Liste des auteurs présents dans la liste d'inclusion |
» limit | integer(int64) | true | none | Quantité maximale d'auteur par page tel que passé en paramètre |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total d'auteur |
GET-Inclusion-Notice
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /perimetres/comptes/{username}/inclusions/notices/ean
Endpoint de consultation des eans inclus dans le perimetre pilote du compte
Consultation paginée des eans dans le périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale d'ean par page |
offset | query | integer | false | Offset pour la page appelée |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» eans | string | true | none | Liste des eans présents dans la liste d'inclusion |
» limit | integer(int64) | true | none | Quantité maximale d'ean par page tel que passé en paramètre |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total d'ean |
PUT-Inclusion-Notice
Code samples
# You can also use wget
curl -X PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /perimetres/comptes/{username}/inclusions/notices/ean/{ean}
Endpoint pour inclure une notice dans le perimetre pilote du compte
Inclus la notice dénotée par l'EAN au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ean | path | string | true | EAN de la notice concernée par cette inclusion de le périmètre du compte |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
DELETE-Inclusion-Notice
Code samples
# You can also use wget
curl -X DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/notices/ean/{ean}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /perimetres/comptes/{username}/inclusions/notices/ean/{ean}
Endpoint pour supprimer l'inclusion d'une notice dans le perimetre pilote du compte
Supprime l'inclusion de la notice dénotée par l'EAN au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ean | path | string | true | EAN de la notice concernée par cette inclusion de le périmètre du compte |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
PUT-Inclusion-Auteur
Code samples
# You can also use wget
curl -X PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /perimetres/comptes/{username}/inclusions/auteurs/{auteurId}
Endpoint pour inclure un auteur dans le perimetre pilote du compte
Inclus l'auteur dénoté son identifiant au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
auteurId | path | string | true | identifiant de l'auteur à inclure (tel que retourné par les ressources /notice/xxx) |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
DELETE-Inclusion-Auteur
Code samples
# You can also use wget
curl -X DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/auteurs/{auteurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /perimetres/comptes/{username}/inclusions/auteurs/{auteurId}
Endpoint pour supprimer l'inclusion d'un auteur dans le perimetre pilote du compte
Supprime l'inclusion de l'auteur dénotée par son identifiant au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
auteurId | path | string | true | identifiant de l'auteur à retirer de l'inclusion (tel que retourné par les ressources /notice/xxx) |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
GET-Inclusion-Editeur
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/inclusions/editeurs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /perimetres/comptes/{username}/inclusions/editeurs
Endpoint de consultation des editeurs inclus dans le perimetre pilote du compte
Consultation paginée des éditeurs dans le périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale d'éditeur par page |
offset | query | integer | false | Offset pour la page appelée |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» editeurs | string | true | none | Liste des éditeurs présents dans la liste d'inclusion |
» limit | integer(int64) | true | none | Quantité maximale de notices par page tel que passé en paramètre |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total de notices |
Périmètres Pilotés par exclusion
External API endpoints for managing perimeter by exclusion list
PUT-Exclusion-Auteur
Code samples
# You can also use wget
curl -X PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /perimetres/comptes/{username}/exclusions/auteurs/{auteurId}
Endpoint pour exclure un auteur dans le perimetre pilote du compte
Exclus l'auteur dénoté son identifiant au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
auteurId | path | string | true | identifiant de l'auteur à exclure (tel que retourné par les ressources /notice/xxx) |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
DELETE-Exclusion-Auteur
Code samples
# You can also use wget
curl -X DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs/{auteurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /perimetres/comptes/{username}/exclusions/auteurs/{auteurId}
Endpoint pour supprimer l'exclusion d'un auteur dans le perimetre pilote du compte
Supprime l'exclusion de l'auteur dénotée par son identifiant au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
auteurId | path | string | true | identifiant de l'auteur à retirer de l'exclusion (tel que retourné par les ressources /notice/xxx) |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
PUT-Exclusion-Editeur
Code samples
# You can also use wget
curl -X PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /perimetres/comptes/{username}/exclusions/editeurs/{editeurId}
Endpoint pour exclure un editeur dans le perimetre pilote du compte
Exclus l'editeur dénoté par son identifiant au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
editeurId | path | string | true | identifiant de l'éditeur à exclure (tel que retourné par les ressources /notice/xxx) |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
DELETE-Exclusion-Editeur
Code samples
# You can also use wget
curl -X DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs/{editeurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /perimetres/comptes/{username}/exclusions/editeurs/{editeurId}
Endpoint pour supprimer l'exclusion d'un editeur dans le perimetre pilote du compte
Supprime l'exclusion de l'editeur dénotée par son identifiant au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
editeurId | path | string | true | identifiant de l'éditeur à retirer de l'exclusion (tel que retourné par les ressources /notice/xxx) |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
GET-Exclusion-Auteur
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/auteurs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /perimetres/comptes/{username}/exclusions/auteurs
Endpoint de consultation des auteurs exclus dans le perimetre pilote du compte
Consultation paginée des auteurs dans le périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale d'auteur par page |
offset | query | integer | false | Offset pour la page appelée |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» auteurs | string | true | none | Liste des auteurs présents dans la liste d'exclusion |
» limit | integer(int64) | true | none | Quantité maximale d'auteur par page tel que passé en paramètre |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total d'auteur |
PUT-Exclusion-Notice
Code samples
# You can also use wget
curl -X PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /perimetres/comptes/{username}/exclusions/notices/ean/{ean}
Endpoint pour exclure une notice dans le perimetre pilote du compte
Exclus la notice dénotée par l'EAN au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ean | path | string | true | EAN de la notice concernée par cette exclusion de le périmètre du compte |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
DELETE-Exclusion-Notice
Code samples
# You can also use wget
curl -X DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean/{ean}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /perimetres/comptes/{username}/exclusions/notices/ean/{ean}
Endpoint pour supprimer l'exclusion d'une notice dans le perimetre pilote du compte
Supprime l'exclusion de la notice dénotée par l'EAN au périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ean | path | string | true | EAN de la notice concernée par cette exclusion de le périmètre du compte |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
GET-Exclusion-Editeur
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/editeurs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /perimetres/comptes/{username}/exclusions/editeurs
Endpoint de consultation des editeurs exclus dans le perimetre pilote du compte
Consultation paginée des éditeurs dans le périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale d'éditeur par page |
offset | query | integer | false | Offset pour la page appelée |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» editeurs | string | true | none | Liste des éditeurs présents dans la liste d'exclusion |
» limit | integer(int64) | true | none | Quantité maximale d'éditeur par page tel que passé en paramètre |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total d'éditeur |
GET-Exclusion-Notice
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/perimetres/comptes/{username}/exclusions/notices/ean", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /perimetres/comptes/{username}/exclusions/notices/ean
Endpoint de consultation des eans exclus dans le perimetre pilote du compte
Consultation paginée des eans dans le périmètre piloté du compte
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale d'ean par page |
offset | query | integer | false | Offset pour la page appelée |
username | path | string | true | le username du compte à qui appartient ce périmètre |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» eans | string | true | none | Liste des eans présents dans la liste d'exclusion |
» limit | integer(int64) | true | none | Quantité maximale d'ean par page tel que passé en paramètre |
» offset | integer(int64) | true | none | Offset, tel que passé en paramètre |
» total | integer(int64) | true | none | Nombre total d'ean |
Champs Extras
External API endpoints to add specific and open data to a notice for an organization
GET-Notice-Champs-Extras
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notices/ean/{ean}/orgs/{orgId}/champs-extras
Notice - identified by the ean - data specific to that organization endpoint
API to get the organization data related to a particular Notice (called Champs Extras)
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ean | path | string | true | EAN de la notice pour laquelle les champs extras sont demandés |
orgId | path | string | true | Identifiant de l'organisation pour laquelle les champs extras sont demandés |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» stock | integer(int64) | false | none | Stock courant |
» rayonsClient | [object] | false | none | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»» usageRayonId | string | true | none | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»» rayonClientId | string | true | none | identifiant du rayon dans la classification |
»» libelleRayonClient | string | true | none | Libellé dans la classification de l'organisation |
» populariteOrganisation | integer(int64) | false | none | La popularité organisation, ajoutée à la popularité Electre pour augmenter le score lors d'une recherche. Doit être positive. |
» champLibre10 | string | false | none | champ libre 10, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre2 | string | false | none | champ libre 2, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre1 | string | false | none | champ libre 1, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre7 | string | false | none | champ libre 7, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» delaiLivraison | string | false | none | Disponibilité en magasin ou délai de livraison |
» champLibre8 | string | false | none | champ libre 8, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre6 | string | false | none | champ libre 6, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre4 | string | false | none | champ libre 4, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» nombreVues | integer(int64) | false | none | nombre de consultations de la notice sur le site |
» prixPromo | object | false | none | Prix de vente de l'ouvrage |
»» devise | string | true | none | Code ISO de la devise |
»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»» ttc | number(double) | true | none | Montant TTC |
» champLibre5 | string | false | none | champ libre 5, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» prix | object | false | none | Prix de vente de l'ouvrage |
»» devise | string | true | none | Code ISO de la devise |
»» taxes | [object] | false | none | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»» taxeId | string | true | none | Identifiant de la taxe (TVA) |
»»» horsTaxe | number(double) | true | none | Montant hors taxe sur lequel la taxe s'applique |
»»» tauxTva | number(double) | true | none | Taux de taxe appliqué |
»» ttc | number(double) | true | none | Montant TTC |
» ventes | integer(int64) | false | none | nombre d'exemplaires vendus, sur une période donnée |
» champLibre9 | string | false | none | champ libre 9, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre3 | string | false | none | champ libre 3, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
PUT-Notice-Champs-Extras
Code samples
# You can also use wget
curl -X PUT https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Content-Type: application/json
Accept: */*
const inputBody = '{
"stock": "25",
"rayonsClient": "",
"populariteOrganisation": "",
"champLibre10": "",
"champLibre2": "",
"champLibre1": "",
"champLibre7": "",
"delaiLivraison": "A commander",
"champLibre8": "",
"champLibre6": "",
"champLibre4": "",
"nombreVues": "455",
"prixPromo": "",
"champLibre5": "",
"prix": "",
"ventes": "13",
"champLibre9": "",
"champLibre3": ""
}';
const headers = {
'Content-Type':'application/json',
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras', headers = headers)
print(r.json())
'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.demo.electre-ng-horsprod.com/notices/ean/{ean}/orgs/{orgId}/champs-extras", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /notices/ean/{ean}/orgs/{orgId}/champs-extras
Endpoint to associate data specific to an organization (called Champs Extras) to a particular Notice identified by its ean
API to store the organization data (Champs Extras) related to a particular Notice
Body parameter
{
"stock": "25",
"rayonsClient": "",
"populariteOrganisation": "",
"champLibre10": "",
"champLibre2": "",
"champLibre1": "",
"champLibre7": "",
"delaiLivraison": "A commander",
"champLibre8": "",
"champLibre6": "",
"champLibre4": "",
"nombreVues": "455",
"prixPromo": "",
"champLibre5": "",
"prix": "",
"ventes": "13",
"champLibre9": "",
"champLibre3": ""
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ean | path | string | true | EAN de la notice sur laquelle les champs extras vont être associés |
orgId | path | string | true | Identifiant de l'organisation à laquelles les champs extras vont être associés |
body | body | object | true | Body |
» stock | body | integer(int64) | false | Stock courant |
» rayonsClient | body | [object] | false | classification personalisée de l'organisation calculée à partir des index Electre, pour un usage donné (site web, PIM, système de gestion...) |
»» usageRayonId | body | string | true | destination de la classification (site web, système de gestion, ou référentiel produit de type PIM) |
»» rayonClientId | body | string | true | identifiant du rayon dans la classification |
»» libelleRayonClient | body | string | true | Libellé dans la classification de l'organisation |
» populariteOrganisation | body | integer(int64) | false | La popularité organisation, ajoutée à la popularité Electre pour augmenter le score lors d'une recherche. Doit être positive. |
» champLibre10 | body | string | false | champ libre 10, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre2 | body | string | false | champ libre 2, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre1 | body | string | false | champ libre 1, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre7 | body | string | false | champ libre 7, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» delaiLivraison | body | string | false | Disponibilité en magasin ou délai de livraison |
» champLibre8 | body | string | false | champ libre 8, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre6 | body | string | false | champ libre 6, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre4 | body | string | false | champ libre 4, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» nombreVues | body | integer(int64) | false | nombre de consultations de la notice sur le site |
» prixPromo | body | object | false | Prix de vente de l'ouvrage |
»» devise | body | string | true | Code ISO de la devise |
»» taxes | body | [object] | false | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»» taxeId | body | string | true | Identifiant de la taxe (TVA) |
»»» horsTaxe | body | number(double) | true | Montant hors taxe sur lequel la taxe s'applique |
»»» tauxTva | body | number(double) | true | Taux de taxe appliqué |
»» ttc | body | number(double) | true | Montant TTC |
» champLibre5 | body | string | false | champ libre 5, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» prix | body | object | false | Prix de vente de l'ouvrage |
»» devise | body | string | true | Code ISO de la devise |
»» taxes | body | [object] | false | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»» taxeId | body | string | true | Identifiant de la taxe (TVA) |
»»» horsTaxe | body | number(double) | true | Montant hors taxe sur lequel la taxe s'applique |
»»» tauxTva | body | number(double) | true | Taux de taxe appliqué |
»» ttc | body | number(double) | true | Montant TTC |
» ventes | body | integer(int64) | false | nombre d'exemplaires vendus, sur une période donnée |
» champLibre9 | body | string | false | champ libre 9, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
» champLibre3 | body | string | false | champ libre 3, champ au format texte, pour des usages spécifiques non couverts par les champs existants |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Notices Organisation
External API endpoints to add your own notice
PUT-Org-Notice
Code samples
# You can also use wget
curl -X PUT https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Content-Type: application/json
Accept: */*
const inputBody = '{
"codeLangue": "",
"auteurs": "",
"dateParution": "",
"quatriemeDeCouverture": "",
"ean": "",
"collections": "",
"titre": "",
"distributeur": "",
"editeurs": "",
"disponibiliteEtendueId": "",
"prix": "",
"descriptionPhysique": "",
"typeProduitId": "",
"isbn": ""
}';
const headers = {
'Content-Type':'application/json',
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}', headers = headers)
print(r.json())
'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /orgs/{orgId}/notices/{orgNoticeId}
Endpoint pour ajouter une notice specifique a cette organisation
Ajoute une notice a cette organisation
Body parameter
{
"codeLangue": "",
"auteurs": "",
"dateParution": "",
"quatriemeDeCouverture": "",
"ean": "",
"collections": "",
"titre": "",
"distributeur": "",
"editeurs": "",
"disponibiliteEtendueId": "",
"prix": "",
"descriptionPhysique": "",
"typeProduitId": "",
"isbn": ""
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | identifiant de l'organisation (est fourni par Electre) |
orgNoticeId | path | integer | true | identifiant de la notice dans l'organisation |
body | body | object | true | Body |
» codeLangue | body | string | false | Langue dans laquelle est écrit l'ouvrage. |
» auteurs | body | [object] | false | auteurs de l'ouvrage |
»» codeContribution | body | string | true | Code de contribution ("A01" pour "Auteur", "A05" pour "Traducteur") cf. codes |
»» auteurId | body | string | true | identifiant de l'auteur |
»» nom | body | string | false | nom de l'auteur |
»» prenom | body | string | false | prénom de l'auteur |
»» formebib | body | string | true | forme bibliographique de l'auteur |
» dateParution | body | string | false | Date de parution au format YYYY-MM-DD |
» quatriemeDeCouverture | body | string | false | Résumé ou quatrième de couverture, sera renvoyé dans le champ "quatrième de couverture" |
» ean | body | string | true | Identifiant EAN de l'ouvrage |
» collections | body | [object] | false | collection d'ouvrages chez un éditeur |
»» collectionId | body | string | true | identifiant de la collection |
»» noDeCollection | body | string | false | numéro de l'ouvrage dans la collection |
»» libelleCollection | body | string | true | libellé de la collection |
» titre | body | string | true | Titre complet de l'ouvrage |
» distributeur | body | object | false | Distributeur |
»» distributeurId | body | string | true | identifiant du distributeur Electre |
»» globalLocationNumber | body | integer(int64) | false | code distributeur GLN (Global Location Number) |
»» raisonSociale | body | string | true | raison sociale du distributeur |
» editeurs | body | [object] | true | Editeurs |
»» editeurId | body | string | true | identifiant Electre de l'éditeur |
»» formeBibEditeur | body | string | true | Forme bibliographique de l'éditeur |
»» lieuPublication | body | string | false | Ville du lieu d'édition |
» disponibiliteEtendueId | body | integer(int64) | true | Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 |
» prix | body | object | true | Prix de vente de l'ouvrage |
»» devise | body | string | true | Code ISO de la devise |
»» taxes | body | [object] | false | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»» taxeId | body | string | true | Identifiant de la taxe (TVA) |
»»» horsTaxe | body | number(double) | true | Montant hors taxe sur lequel la taxe s'applique |
»»» tauxTva | body | number(double) | true | Taux de taxe appliqué |
»» ttc | body | number(double) | true | Montant TTC |
» descriptionPhysique | body | object | false | Description physique de l'ouvrage |
»» nbPages | body | string | false | nombre de pages |
»» largeur | body | number(double) | false | largeur de l'ouvrage, en centimètres |
»» hauteur | body | number(double) | false | hauteur de l'ouvrage, en centimètres |
»» epaisseur | body | number(double) | false | épaisseur en cm |
»» poids | body | integer(int64) | false | poids de l'ouvrage, en grammes |
» typeProduitId | body | string | true | Identifiant du type de produit (cf. nomenclature) |
» isbn | body | string | false | International Standard Book Number (ISBN 13) |
Detailed descriptions
» disponibiliteEtendueId: Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 Mapping : disponible 1 a-paraitre 2 reimpression-en-cours 3 manque-provisoirement 4 epuise 5 arret-de-commercialisation 6 ne-sera-plus-distribue 7 a-reparaitre 8 parution-annulee 9
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
POST-Org-Notice
Code samples
# You can also use wget
curl -X POST https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
POST https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Content-Type: application/json
Accept: */*
const inputBody = '{
"codeLangue": "",
"auteurs": "",
"dateParution": "",
"quatriemeDeCouverture": "",
"ean": "",
"collections": "",
"titre": "",
"distributeur": "",
"editeurs": "",
"disponibiliteEtendueId": "",
"prix": "",
"descriptionPhysique": "",
"typeProduitId": "",
"isbn": ""
}';
const headers = {
'Content-Type':'application/json',
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}', headers = headers)
print(r.json())
'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /orgs/{orgId}/notices/{orgNoticeId}
Endpoint pour mettre a jour une notice specifique a cette organisation
Met a jour une notice a cette organisation
Body parameter
{
"codeLangue": "",
"auteurs": "",
"dateParution": "",
"quatriemeDeCouverture": "",
"ean": "",
"collections": "",
"titre": "",
"distributeur": "",
"editeurs": "",
"disponibiliteEtendueId": "",
"prix": "",
"descriptionPhysique": "",
"typeProduitId": "",
"isbn": ""
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | identifiant de l'organisation (est fourni par Electre) |
orgNoticeId | path | integer | true | identifiant de la notice dans l'organisation |
body | body | object | true | Body |
» codeLangue | body | string | false | Langue dans laquelle est écrit l'ouvrage. |
» auteurs | body | [object] | false | auteurs de l'ouvrage |
»» codeContribution | body | string | true | Code de contribution ("A01" pour "Auteur", "A05" pour "Traducteur") cf. codes |
»» auteurId | body | string | true | identifiant de l'auteur |
»» nom | body | string | false | nom de l'auteur |
»» prenom | body | string | false | prénom de l'auteur |
»» formebib | body | string | true | forme bibliographique de l'auteur |
» dateParution | body | string | false | Date de parution au format YYYY-MM-DD |
» quatriemeDeCouverture | body | string | false | Résumé ou quatrième de couverture, sera renvoyé dans le champ "quatrième de couverture" |
» ean | body | string | true | Identifiant EAN de l'ouvrage |
» collections | body | [object] | false | collection d'ouvrages chez un éditeur |
»» collectionId | body | string | true | identifiant de la collection |
»» noDeCollection | body | string | false | numéro de l'ouvrage dans la collection |
»» libelleCollection | body | string | true | libellé de la collection |
» titre | body | string | true | Titre complet de l'ouvrage |
» distributeur | body | object | false | Distributeur |
»» distributeurId | body | string | true | identifiant du distributeur Electre |
»» globalLocationNumber | body | integer(int64) | false | code distributeur GLN (Global Location Number) |
»» raisonSociale | body | string | true | raison sociale du distributeur |
» editeurs | body | [object] | true | Editeurs |
»» editeurId | body | string | true | identifiant Electre de l'éditeur |
»» formeBibEditeur | body | string | true | Forme bibliographique de l'éditeur |
»» lieuPublication | body | string | false | Ville du lieu d'édition |
» disponibiliteEtendueId | body | integer(int64) | true | Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 |
» prix | body | object | true | Prix de vente de l'ouvrage |
»» devise | body | string | true | Code ISO de la devise |
»» taxes | body | [object] | false | Détail des taxes : TVA sur le livre (ou sur un autre type de produit si l'article comprend d'autres types de produits) |
»»» taxeId | body | string | true | Identifiant de la taxe (TVA) |
»»» horsTaxe | body | number(double) | true | Montant hors taxe sur lequel la taxe s'applique |
»»» tauxTva | body | number(double) | true | Taux de taxe appliqué |
»» ttc | body | number(double) | true | Montant TTC |
» descriptionPhysique | body | object | false | Description physique de l'ouvrage |
»» nbPages | body | string | false | nombre de pages |
»» largeur | body | number(double) | false | largeur de l'ouvrage, en centimètres |
»» hauteur | body | number(double) | false | hauteur de l'ouvrage, en centimètres |
»» epaisseur | body | number(double) | false | épaisseur en cm |
»» poids | body | integer(int64) | false | poids de l'ouvrage, en grammes |
» typeProduitId | body | string | true | Identifiant du type de produit (cf. nomenclature) |
» isbn | body | string | false | International Standard Book Number (ISBN 13) |
Detailed descriptions
» disponibiliteEtendueId: Valeur de disponibilité parmi 1,2 ,3 ,4, 5, 6, 7 ,8, 9 Mapping : disponible 1 a-paraitre 2 reimpression-en-cours 3 manque-provisoirement 4 epuise 5 arret-de-commercialisation 6 ne-sera-plus-distribue 7 a-reparaitre 8 parution-annulee 9
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
DELETE-Org-Notice
Code samples
# You can also use wget
curl -X DELETE https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /orgs/{orgId}/notices/{orgNoticeId}
Endpoint pour supprimer une notice specifique a cette organisation
Supprime une notice de cette organisation
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | identifiant de l'organisation (est fourni par Electre) |
orgNoticeId | path | integer | true | identifiant de la notice dans l'organisation |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
GET-Org-Notice
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/orgs/{orgId}/notices/{orgNoticeId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /orgs/{orgId}/notices/{orgNoticeId}
Endpoint pour recuperer une notice specifique a cette organisation
Recupere une notice propre de cette organisation
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | identifiant de l'organisation (est fourni par Electre) |
orgNoticeId | path | integer | true | identifiant de la notice dans l'organisation |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Auteurs
GET-Auteurs-Search
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/auteurs/search?q= \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/auteurs/search?q= HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/auteurs/search?q=',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/auteurs/search',
params: {
'q' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/auteurs/search', params={
'q': ''
}, headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/auteurs/search', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/auteurs/search?q=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/auteurs/search", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /auteurs/search
Endpoint pour chercher des auteurs
Cherche des auteurs
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale d'auteur par page |
offset | query | integer | false | Offset pour la page appelée |
q | query | string | true | Recherche sur la forme bibliographique des auteurs |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» auteurs | [object] | true | none | Liste des auteurs renvoyés |
»» auteurId | string | true | none | Identifiant de l'auteur |
»» formebib | string | true | none | Forme bibliographique du nom de l'auteur + qualificatifs |
»» codeTypeAuteur | string | false | none | Code du type de l'auteur : "P" (personne physique) ; "C" (collectivité) ; "M" (manifestation) |
» limit | integer(int64) | true | none | Quantité maximale d'auteur par page |
» offset | integer(int64) | true | none | Offset pour la page appelée |
» total | integer(int64) | true | none | Nombre total de notices |
GET-Auteurs-Id
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/auteurs/{auteurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/auteurs/{auteurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/auteurs/{auteurId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/auteurs/{auteurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/auteurs/{auteurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/auteurs/{auteurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/auteurs/{auteurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/auteurs/{auteurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /auteurs/{auteurId}
Endpoint pour recuperer les informations d'un auteur
Recupere les informations d'un auteur
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
auteurId | path | string | true | Identifiant de l'auteur |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» auteurId | string | true | none | Identifiant de l'auteur |
» codeTypeAuteur | string | false | none | Code du type de l'auteur : "P" (personne physique) ; "C" (collectivité) ; "M" (manifestation) |
» formebib | string | true | none | Forme bibliographique du nom de l'auteur + qualificatifs |
Editeurs
GET-Editeurs-Search
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/editeurs/search?q= \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/editeurs/search?q= HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/editeurs/search?q=',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/editeurs/search',
params: {
'q' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/editeurs/search', params={
'q': ''
}, headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/editeurs/search', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/editeurs/search?q=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/editeurs/search", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /editeurs/search
Endpoint pour chercher des éditeurs
Cherche des éditeurs
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Quantité maximale d'éditeur par page |
offset | query | integer | false | Offset pour la page appelée |
q | query | string | true | Recherche sur la raison sociale des éditeurs, distributeurs, diffuseurs... |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» limit | integer(int64) | true | none | Quantité maximale d'auteur par page |
» offset | integer(int64) | true | none | Offset pour la page appelée |
» societes | [object] | true | none | Liste des auteurs renvoyés |
»» societeId | string | true | none | Identifiant de l'éditeur, distributeur, diffuseur... |
»» raisonSociale | string | true | none | Raison sociale de l'éditeur, distributeur, diffuseur... |
»» formeBibliographique | string | false | none | Forme bibliographique de l'éditeur, distributeur, diffuseur... |
»» autresAppelations | [string] | false | none | Autres appelations de l'éditeur, distributeur, diffuseur... |
»» typeActivite | string | false | none | Code du type d'activité : "1" (éditeur) ; "2" (auto-édition) ; "3" (commercialisation du livre) ; "3.01" (diffusion) ; "3.02" (distribution) ; "3.03" ( diffusion / distribution) ; "3.04" (libraire) ; "3.05" (grossiste) ; "3.06" (comptoir de vente) ; "3.07" (importateur) |
»» nationalite | string | true | none | Nationalité de l'éditeur, distributeur, diffuseur... |
»» cnuf | integer(int64) | false | none | Code national unifié fournisseur |
» total | integer(int64) | true | none | Nombre total de notices |
GET-Editeurs-Id
Code samples
# You can also use wget
curl -X GET https://api.demo.electre-ng-horsprod.com/editeurs/{editeurId} \
-H 'Accept: */*' \
-H 'Authorization: Bearer {access-token}'
GET https://api.demo.electre-ng-horsprod.com/editeurs/{editeurId} HTTP/1.1
Host: api.demo.electre-ng-horsprod.com
Accept: */*
const headers = {
'Accept':'*/*',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.demo.electre-ng-horsprod.com/editeurs/{editeurId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.demo.electre-ng-horsprod.com/editeurs/{editeurId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.demo.electre-ng-horsprod.com/editeurs/{editeurId}', headers = headers)
print(r.json())
'*/*',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.demo.electre-ng-horsprod.com/editeurs/{editeurId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.demo.electre-ng-horsprod.com/editeurs/{editeurId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.demo.electre-ng-horsprod.com/editeurs/{editeurId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /editeurs/{editeurId}
Endpoint pour recuperer les informations d'un éditeur
Recupere les informations d'un éditeur
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
editeurId | path | string | true | Identifiant de l'éditeur, distributeur, diffuseur... |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response for operation | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» autresAppelations | [string] | false | none | Autres appelations de l'éditeur, distributeur, diffuseur... |
» cnuf | integer(int64) | false | none | Code national unifié fournisseur |
» formeBibliographique | string | false | none | Forme bibliographique de l'éditeur, distributeur, diffuseur... |
» nationalite | string | true | none | Nationalité de l'éditeur, distributeur, diffuseur... |
» raisonSociale | string | true | none | Raison sociale de l'éditeur, distributeur, diffuseur... |
» societeId | string | true | none | Identifiant de l'éditeur, distributeur, diffuseur... |
» typeActivite | string | false | none | Code du type d'activité : "1" (éditeur) ; "2" (auto-édition) ; "3" (commercialisation du livre) ; "3.01" (diffusion) ; "3.02" (distribution) ; "3.03" ( diffusion / distribution) ; "3.04" (libraire) ; "3.05" (grossiste) ; "3.06" (comptoir de vente) ; "3.07" (importateur) |