mod-circulation/ramls/for-use-at-location-shelf.raml at master · folio-org/mod-circulation · 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
#%RAML 1.0
title: Change usage status of items to be used at location (ie reading room)
version: v0.1
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost:9130

documentation:
  - title: API for changing usage status of items used at location
    content: <b>Change usage status API</b>

types:
  errors: !include raml-util/schemas/errors.schema

traits:
  validate: !include raml-util/traits/validation.raml

/circulation:
  /hold-by-barcode-for-use-at-location:
    post:
      is: [validate]
      body:
        application/json:
          type: !include hold-for-use-at-location-request.json
      responses:
        200:
          description: "The at-location usage status of the loaned item set to held"
        422:
          description: "Unable to change the usage status for the loan"
          body:
            application/json:
              type: errors
              example: !include examples/at-location-usage-status-change-error.json
        404:
          description: "The loan is not found"
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"

  /pickup-by-barcode-for-use-at-location:
    post:
      is: [validate]
      body:
        application/json:
          type: !include pickup-for-use-at-location-request.json
      responses:
        200:
          description: "The at-location usage status of the loaned item set to in-use"
        422:
          description: "Unable to change the usage status for the loan"
          body:
            application/json:
              type: errors
              example: !include examples/at-location-usage-status-change-error.json
        404:
          description: "The loan is not found"
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"