mod-finance/ramls/exchange-batch.raml at master · folio-org/mod-finance · 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
#%RAML 1.0

title: Exchange Batch
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: https://github.com/folio-org/mod-finance

documentation:
  - title: Exchange Batch API
    content: This documents the API calls that can be made to get exchange batch operations

types:
  errors: !include raml-util/schemas/error.schema
  exchange_rate_calculations: !include acq-models/mod-finance/schemas/exchange_rate_calculations.json

/finance/calculate-exchange-batch:
  displayName: Calculate exchange batch
  description: Calculate exchange batch API
  post:
    description: "Get exchange calculation in batch"
    body:
      application/json:
        type: exchange_rate_calculations
        example:
          strict: false
          value: !include acq-models/mod-finance/examples/exchange_rate_calculations.sample
    responses:
      200:
        description: "Exchange calculation successfully retrieved"
        body:
          application/json:
            type: exchange_rate_calculations
            example:
              strict: false
              value: !include acq-models/mod-finance/examples/exchange_rate_calculations.sample
      400:
        description: "Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response."
        body:
          application/json:
            type: errors
            example:
              strict: false
              value: !include raml-util/examples/error.sample
      404:
        description: "Exchange rate is not available"
        body:
          application/json:
            type: errors
            example:
              strict: false
              value: !include raml-util/examples/error.sample
      500:
        description: "Internal server error, e.g. due to misconfiguration"
        body:
          application/json:
            type: errors
            example:
              strict: false
              value: !include raml-util/examples/error.sample