marcxml2tei/marcxml2tei-OpenAPI-schema.yaml at main · abes-esr/marcxml2tei · GitHub

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
openapi: 3.0.0
servers:
  - description: Service web marcxml2tei
    url: https://www.sudoc.fr/services/marcxml2tei
info:
  description: |
    Produit des notices TEI à partir de notices de documents universitaires au format [MarcXML](http://documentation.abes.fr/sudoc/manuels/administration/aidewebservices/index.html#SudocMarcXML).
  version: "1.0.0"
  title: MarcXML2TEI
  license:
    name: CeCILL 2.1
    url: 'https://cecill.info/licences/Licence_CeCILL_V2.1-fr.txt'
paths:
  /{ppn}:
    parameters:
    - in: path
      name: ppn
      schema:
        type: string
        pattern: '^\d{8}(X|\d)$'
      required: true
      example: "252383524"
      description: PPN de la notice Sudoc
    get:
      summary: Transforme une notice marcXML en TEI
      operationId: MarcXML2TEI
      description: |
        Transforme une notice marcXML en TEI

        Seule les notices conformes aux règles de catalogage des [travaux universitaires hors thèses](http://documentation.abes.fr/sudoc/regles/Catalogage/Regles_Theses_AutresDocsUniv.htm) peuvent être transformées au format TEI.

      responses:
        '500':
          description: Échec de la transformation. Le document n'est pas un travail universitaire hors thèses.
          content:
            application/xml:
              schema:
                "$ref": "#/components/schemas/error"
              example: |
                <error>Found a null xml in result : values={leppn=254516424}, query=select autorites.biblio_tei(#leppn#) from dual</error>
        '200':
          description: Succès de la transformation
          content:
            application/xml:
              schema:
                "$ref": "#/components/schemas/TEI"
              example: |
                <TEI xmlns="http://www.tei-c.org/ns/1.0"
                  xmlns:ext="http://exslt.org/common"
                  xmlns:hal="http://hal.archives-ouvertes.fr/"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://www.tei-c.org/ns/1.0 http://api.archives-ouvertes.fr/documents/aofr-sword.xsd">
                  <text>
                    <body>
                      <listBibl>
                        <biblFull>
                          <notesStmt>
                            <note type="audience" n="3"/>
                            <note type="degree" n="23"/>
                          </notesStmt>
                          <sourceDesc>
                            <biblStruct>
                              <analytic>
                                <title xml:lang="fr">La longévité politique : être et rester un élu de la République. L’exemple d’Amédée Bouquerel, sénateur de l’Oise de 1948 à 1992</title>
                                <author role="aut">
                                  <persName>
                                    <forename type="first">Carpi</forename>
                                      <surname>Benjamin</surname>
                                    </persName>
                                  <idno type="IdRef">https://www.idref.fr/252385659</idno>
                                </author>
                              </analytic>
                              <monogr>
                                <imprint>
                                  <biblScope unit="pp">183</biblScope>
                                  <date type="dateDefended">2020-01-01</date>
                                </imprint>
                                <authority type="supervisor">David Bellamy</authority>
                              </monogr>
                            </biblStruct>
                          </sourceDesc>
                          <profileDesc>
                            <langUsage>
                              <language ident="fr"/>
                            </langUsage>
                            <textClass>
                              <keywords scheme="author">
                                <term xml:lang="fr">Gaullisme</term>
                                <term xml:lang="fr">France</term>
                              </keywords>
                              <classCode scheme="halTypology" n="MEM"/>
                            </textClass>
                            <abstract xml:lang="fr">Lorem ipsum dolor sit amet</abstract>
                            <abstract xml:lang="en">Lorem ipsum dolor sit amet</abstract>
                            </profileDesc>
                          </biblFull>
                        </listBibl>
                      </body>
                    </text>
                  </TEI>
components:
  schemas:
    TEI:
      type: object
      description: "données au format tei"
    error:
      type: string
      description: "message d'erreur"