-
Notifications
You must be signed in to change notification settings - Fork 1
/
idref.yaml
488 lines (423 loc) · 20.7 KB
/
idref.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
openapi: 3.0.0
info:
title: idref
version: '1.0'
description: API de récupération des notices d'autorités du Système Universitaire de Documentation (Sudoc) de l'ESR
contact:
name: ABES
url: 'https://stp.abes.fr/node/3?origine=idref'
email: idref@abes.fr
termsOfService: 'https://www.idref.fr/cgu.jsp'
license:
name: Licence Ouverte Etalab
url: 'https://www.etalab.gouv.fr/licence-ouverte-open-licence'
servers:
- url: 'https://www.idref.fr'
paths:
/Sru/Solr:
get:
summary: ''
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-Sru-Solr
description: |-
Renvoie les informations sur les notices d'autorités du Système Universitaire de Documentation (Sudoc).
Il s'agit d'une <a href="https://svn.apache.org/repos/asf/lucene/solr/tags/release-1.4.1/site/tutorial.html#Querying+Data" target="_blank">API Solr 1.41</a>
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#UtiliserApiSolr" target=_blank>Lien vers la documentation</a>
Exemples :
<a href="https://www.idref.fr/Sru/Solr?q=persname_t:(Bourdieu AND Pierre)&sort=score%20desc&version=2.2&start=0&rows=30&indent=on&fl=id,ppn_z,recordtype_z,affcourt_z" target=_blank>Exemple 1</a>
<a href="https://www.idref.fr/Sru/Solr?q=persname_t:pepin&sort=score%20desc&version=2.2&start=0&rows=30&indent=on&fl=id,ppn_z,recordtype_z,affcourt_z" target=_blank>Exemple 2</a>
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
parameters:
- schema:
type: string
example: '*:*'
in: query
name: q
description: Critères de recherche
required: true
- schema:
type: string
example: ppn_z asc
in: query
name: sort
description: Tri par index
- schema:
type: string
example: '0'
in: query
name: start
description: Démarre au nième résultat (pour pagination)
- schema:
type: string
example: '10'
in: query
name: rows
description: Nombre de documents maximum à retourner
- schema:
type: string
example: '*'
in: query
name: fl
description: Liste des indexes à retourner
- schema:
type: string
enum:
- json
- xml
example: json
in: query
name: wt
description: 'Format retourné : XML (par défaut) ou JSON'
- schema:
type: string
enum:
- 'on'
- 'off'
example: 'on'
in: query
name: facet
description: Active les facettes dans la réponse. A utiliser avec facet.field
- schema:
type: string
example: recordtype_z
in: query
name: facet.field
description: Index sur lequel avoir les facettes
'/{PPN}':
parameters:
- $ref: '#/components/parameters/PPN'
get:
tags: []
responses:
'200':
description: OK
headers:
'content-type: application/rdf+xml;charset=UTF-8':
schema:
type: string
'404':
description: Not Found
operationId: get-PPN
parameters:
- schema:
type: string
example: application/xml
enum:
- application/xml
- application/rdf+xml
in: header
name: Accept
description: Format demandé
description: |-
Renvoie une notice d'autorité correspondant à un PPN (identifiant), en MarcXML ou RDF, selon le header HTTP Accept
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#FormatRdf" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/027182800
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
'/{PPN}.xml':
parameters:
- $ref: '#/components/parameters/PPN'
get:
tags: []
responses:
'200':
description: OK
headers: {}
'404':
description: Not found
operationId: get-PPN-.xml
description: |-
Renvoie une notice d'autorité correspondant à un PPN (identifiant), au format XML
<a href="https://status-api.abes.fr/783699576" target=_blank>Voir la disponibilité du service</a>
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#format" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/027182800.xml
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
x-internal: false
parameters: []
'/{PPN}.rdf':
parameters:
- $ref: '#/components/parameters/PPN'
get:
tags: []
responses:
'200':
description: OK
'404':
description: Not found
operationId: get-PPN-.rdf
description: |-
Renvoie une notice d'autorité correspondant à un PPN (identifiant), au format RDF
<a href="https://status-api.abes.fr/783699580" target=_blank>Voir la disponibilité du service</a>
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#FormatRdf" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/027182800.rdf
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
'/services/biblio/{PPN}':
parameters:
- $ref: '#/components/parameters/PPN'
get:
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-biblio-PPN
description: |-
Renvoie la liste des références bibliographiques du Sudoc, liées à une notice d'autorité correspondant à un PPN (identifiant). Le format par défaut est MarcXML, mais on peut demander du JSON (par l'header HTTP ou en suffixant avec .json)
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWebBiblio" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/services/biblio/027182800
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
parameters:
- $ref: '#/components/parameters/Accept'
'/services/biblio/{PPN}.xml':
parameters:
- $ref: '#/components/parameters/PPN'
get:
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-biblio-PPN-.xml
description: |-
Renvoie la liste des références bibliographiques du Sudoc, liées à une notice d'autorité correspondant à un PPN (identifiant), en MarcXML
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWebBiblio" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/services/biblio/027182800.xml
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
'/services/biblio/{PPN}.json':
parameters:
- $ref: '#/components/parameters/PPN'
get:
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-biblio-PPN-.json
description: |-
Renvoie la liste des références bibliographiques du Sudoc, liées à une notice d'autorité correspondant à un PPN (identifiant), en JSON
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWebBiblio" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/services/biblio/027182800.json
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
'/services/references/{PPN}':
parameters:
- $ref: '#/components/parameters/PPN'
get:
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-references-PPN
description: |-
Renvoie la liste des références bibliographiques, liées à une notice d'autorité correspondant à un PPN (identifiant). Le format par défaut est MarcXML, mais on peut demander du JSON (par l'header HTTP ou en suffixant avec .json)
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWebReferences" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/services/references/02686018X
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
parameters:
- $ref: '#/components/parameters/Accept'
'/services/references/{PPN}.xml':
parameters:
- $ref: '#/components/parameters/PPN'
get:
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-references-PPN-.xml
description: |-
Renvoie la liste des références bibliographiques, liées à une notice d'autorité correspondant à un PPN (identifiant), en MarcXML
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWebReferences" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/services/references/02686018X.xml
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
'/services/references/{PPN}.json':
parameters:
- schema:
type: string
name: PPN
in: path
required: true
get:
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-references-PPN-.json
description: |-
Renvoie la liste des références bibliographiques du Sudoc, liées à une notice d'autorité correspondant à un PPN (identifiant), en JSON
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWebReferences" target=_blank>Lien vers la documentation</a>
Exemple:
https://www.idref.fr/services/references/02686018X.json
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
/services/listrcrisil:
get:
summary: ''
tags: []
operationId: get-services-listisil
description: |-
Le webservice listrcrisil illustre l'activité de l'Abes en tant qu'agence nationale d'attribution des ISIL (International Standard for Library Identifiers) : il renvoie un fichier excel (.xls) avec la liste de tous les identifiants actifs pour les bibliothèques françaises.
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#listrcr" target=_blank>Lien vers la documentation</a>
Le numéro ISIL est construit sur le numéro RCR, précédé du préfixe « FR-».
Le fichier csv comporte : n°RCR, n°ISIL, intitulé court de la bibliothèque.
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
parameters: []
responses:
'200':
description: OK
'404':
description: Not Found
parameters: []
/services/listrcr:
get:
summary: ''
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-listrcr
description: |-
Le Webservice listrcr renvoie dans un fichier excel (.xls) la liste des RCR actifs ayant une notice RCR (autorité-centre de ressources) : il permet d'établir les correspondances entre les n° RCR (identifiant d'une bibliothèque physique) et les intitulés des établissements membres des réseaux Sudoc / Sudoc PS
Le fichier comporte : n°RCR, intitulé court de la bibliothèque, ILN de rattachement, n°PPN de la notice de centre de ressources, adresse courriel, adresse physique, adresse postale, complément d'adresse, lieu-dit, ville, cedex, code postal, pays.
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#listrcr" target=_blank>Lien vers la documentation</a>
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
'/services/idref2id/{PPN}':
get:
summary: ''
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-idref2id
description: |-
A partir d'un PPN de personne ou de collectivité : obtenir la liste des identifiants d'autres systèmes alignés (BnF, Hal,Orcid,Viaf,Isni,etc.)
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWebIdref2id" target=_blank>Lien vers la documentation</a>
Exemples :
https://www.idref.fr/services/idref2id/027715078
https://www.idref.fr/services/idref2id/159123984,027715078,139753753
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
parameters:
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/format'
parameters:
- $ref: '#/components/parameters/PPN'
'/services/id2idref/{ID}':
get:
summary: ''
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-id2idref
description: |-
A partir de l'identifiant d'une personne ou d'une collectivité dans un autre système (BnF, Hal,Orcid,Viaf,Isni,etc.) : obtenir le numéro PPN associé.
<a href="https://status-api.abes.fr/786474654" target=_blank>Voir la disponibilité du service</a>
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWeb_ServiceId2idref" target=_blank>Lien vers la documentation</a>
Exemples:
https://www.idref.fr/services/id2idref/http://viaf.org/viaf/71387829
https://www.idref.fr/services/id2idref/https://fr.wikipedia.org/wiki/Pierre_Bourdieu,000000024000807X
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
parameters:
- $ref: ./sudoc.yaml#/components/parameters/Accept
- $ref: '#/components/parameters/format'
parameters:
- $ref: '#/components/parameters/ID'
'/services/iln2rcr/{ILN}':
parameters:
- $ref: '#/components/parameters/ILN'
get:
summary: ''
tags: []
responses:
'200':
description: OK
'404':
description: Not Found
operationId: get-services-iln2rcr-ILN
description: |
A partir du numéro ILN identifiant un établissement, obtenir la liste de ses bibliothèques (RCR) partageant le même SIGB (Système Intégré de Gestion des Bibliothèques).
<a href="http://documentation.abes.fr/aideidrefdeveloppeur/index.html#MicroWebIln2rcr" target=_blank>Lien vers la documentation</a>
Exemples:
https://www.idref.fr/services/iln2rcr/4
https://www.idref.fr/services/iln2rcr/4,8
Données disponibles sous <a href="https://www.etalab.gouv.fr/licence-ouverte-open-licence" target=_blank>Licence Ouverte / Open Licence de l’État élaborée par la mission Etalab</a>. La récupération et la réutilisation des données est libre et gratuite sous réserve de l’indication de leur date de récupération et de la mention de leur source.
parameters:
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/format'
components:
schemas: {}
parameters:
PPN:
name: PPN
in: path
required: true
schema:
type: string
pattern: '[0-9]{8}[0-9A-Z]{1}'
minLength: 9
maxLength: 9
example: '139753753'
description: Identifiant d'une notice d'autorité
Accept:
name: Accept
in: header
required: false
schema:
type: string
enum:
- application/xml
- text/xml
- application/json
- text/json
example: application/xml
description: 'Format demandé (XML, JSON)'
format:
name: format
in: query
required: false
schema:
type: string
enum:
- text/json
description: Format demandé
ID:
name: ID
in: path
required: true
schema:
type: string
description: 'Identifiant de personne ou de collectivité dans d''autres référentiels (BnF,Hal,Orcid,Viaf,etc.)'
ILN:
name: ILN
in: path
required: true
schema:
type: string
minLength: 1
maxLength: 3
pattern: '[0-9]{1,3}'
description: identifiant unique d’un établissement participant au réseau du Sudoc. Un ILN peut englober un ou plusieurs RCR