mod-rtac/ramls/rtac.raml at master · folio-org/mod-rtac · 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
#%RAML 1.0
title: Real Time Availability Check
baseUri: https://github.com/folio-org/mod-rtac
version: v1.5

documentation:
  - title: DEPRECATED Real Time Availability Checker Integration
    content: This module allows 3rd party discovery services to check for FOLIO inventory availability

types:
  legacyHoldings: !include deprecated/holdings.json
  legacyHolding: !include deprecated/holding.json

resourceTypes:
  item-collection-get: !include raml-util/rtypes/item-collection-get.raml

/rtac:
  displayName: DEPRECATED RTAC
  description: DEPRECATED RTAC operations
  /{id}:
    displayName: RTAC for the specified id
    description: Returns availability details about each item for the given instance id
    type:
      item-collection-get:
        exampleItem: !include examples/holdings.sample
        schema: legacyHoldings
    uriParameters:
      id:
        description: "The UUID of a FOLIO instance"
        type: string
        pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    get:
      responses:
        400:
          description: "Bad request"
          body:
            text/plain:
              example: |
                "unable to process request -- constraint violation"
        403:
          description: "Access Denied"
          body:
            text/plain:
              example: "Access Denied"