mod-gobi/ramls/gobi.raml at master · folio-org/mod-gobi · 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
#%RAML 1.0
title: GOBI® (Global Online Bibliographic Information) Integration
baseUri: https://github.com/folio-org/mod-gobi
protocols: [ HTTPS ]
version: v1

documentation:
  - title: GOBI® (Global Online Bibliographic Information) Integration
    content: |
      GOBI® (Global Online Bibliographic Information) is the leading web-based
      acquisitions tool for finding, ordering and managing e-books and print
      books for libraries. This module allows GOBI initiated orders to be
      fulfilled by FOLIO.

/gobi:
  /validate:
    displayName: Validate Access to GOBI Integration service
    description: Validates the user has proper access to the module
    get:
      description: Validates the user has proper access to the module
      responses:
        200:
          description: The user is valid
          body:
            application/xml:
              example: "<test>GET - OK</test>"
        401:
          description: Not authorized to perform requested action
          body:
            text/plain:
              example: unable to get account -- unauthorized
        403:
          description: Access Denied
          body:
            text/plain:
              example: Access Denied
        500:
          description: Internal server error, e.g. due to misconfiguration
          body:
            text/plain:
              example: internal server error, contact administrator
    post:
      description: Validates the user has proper access to the module
      responses:
        200:
          description: The user is valid
          body:
            application/xml:
              example: "<test>POST - OK</test>"
        401:
          description: Not authorized to perform requested action
          body:
            text/plain:
              example: unable to get account -- unauthorized
        403:
          description: Access Denied
          body:
            text/plain:
              example: Access Denied
        500:
          description: Internal server error, e.g. due to misconfiguration
          body:
            text/plain:
              example: internal server error, contact administrator
  /orders:
    displayName: Fulfill an order
    description: Fulfill an order that is delivered in GOBI format
    post:
      description: Fulfill an order that is delivered in GOBI format
      body:
        application/xml:
          type: string
          example: !include examples/po.xml
      responses:
        201:
          description: Creates a new order within FOLIO
          body:
            application/xml:
              example: !include examples/response.xml
        400:
          description: Bad request
          body:
            application/xml:
              example: !include examples/error.xml
        401:
          description: Not authorized to perform requested action
          body:
            text/plain:
              example: unable to renew loan -- unauthorized
        403:
          description: Access Denied
          body:
            text/plain:
              example: Access Denied
        500:
          description: |
            Internal server error, e.g. due to misconfiguration
          body:
            application/xml:
              example: !include examples/error.xml