-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathcostperuse.raml
More file actions
176 lines (172 loc) · 5.7 KB
/
costperuse.raml
File metadata and controls
176 lines (172 loc) · 5.7 KB
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
#%RAML 1.0
title: mod-kb-ebsco-java
baseUri: https://github.com/folio-org/mod-kb-ebsco-java
protocols: [ HTTPS ]
version: v1
mediaType: "application/vnd.api+json"
documentation:
- title: mod-kb-ebsco-java
content: Implements the eholdings interface using EBSCO KB as backend.
traits:
costPerUseCommon: !include traits/costPerUseCommon.raml
pageable: !include traits/pageable.raml
sortable: !include traits/sortable.raml
orderable: !include traits/orderable.raml
types:
resourceCostPerUse: !include types/uc/costperuse/resourceCostPerUse.json
resourceCostPerUseCollection: !include types/uc/costperuse/resourceCostPerUseCollection.json
packageCostPerUse: !include types/uc/costperuse/packageCostPerUse.json
titleCostPerUse: !include types/uc/costperuse/titleCostPerUse.json
jsonapiError: !include types/jsonapiError.json
order:
enum: [asc, desc]
/eholdings/resources/{resourceId}/costperuse:
displayName: Cost-per-use
uriParameters:
resourceId:
description: Identifier of the resource formed from Provider Id, Package Id, Title Id
type: string
pattern: "^\\d+-\\d+-\\d+$"
example: 22-1887786-1440285
get:
description: Retrieve cost-per-use information for a particular resource
is: [costPerUseCommon]
responses:
200:
description: OK
body:
application/vnd.api+json:
description: Resource cost-per-use
type: resourceCostPerUse
example:
strict: false
value: !include examples/costPerUse/resource_cost_per_use_200_response.json
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/costPerUse/cost_per_use_400_response.json
422:
description: Unprocessable Entity
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/costPerUse/cost_per_use_422_response.json
/eholdings/titles/{titleId}/costperuse:
displayName: Cost-per-use
uriParameters:
titleId:
description: Identifier of the title
type: string
pattern: "^\\d+$"
example: "440285"
get:
description: Retrieve cost-per-use information for a particular title
is: [costPerUseCommon]
responses:
200:
description: OK
body:
application/vnd.api+json:
description: Title cost-per-use data
type: titleCostPerUse
example:
strict: false
value: !include examples/costPerUse/title_cost_per_use_200_response.json
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/costPerUse/cost_per_use_400_response.json
422:
description: Unprocessable Entity
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/costPerUse/cost_per_use_422_response.json
/eholdings/packages/{packageId}/costperuse:
displayName: Cost-per-use
uriParameters:
packageId:
description: Identifier of the package
type: string
pattern: "^\\d+-\\d+$"
example: "15-440285"
get:
description: Retrieve cost-per-use information for a particular package
is: [costPerUseCommon]
responses:
200:
description: OK
body:
application/vnd.api+json:
description: Package cost-per-use data
type: packageCostPerUse
example:
strict: false
value: !include examples/costPerUse/package_cost_per_use_200_response.json
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/costPerUse/cost_per_use_400_response.json
422:
description: Unprocessable Entity
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/costPerUse/cost_per_use_422_response.json
/eholdings/packages/{packageId}/resources/costperuse:
displayName: Cost-per-use
uriParameters:
packageId:
description: Identifier of the package
type: string
pattern: "^\\d+-\\d+$"
example: "15-440285"
get:
description: Retrieve cost-per-use information for package resources
is: [costPerUseCommon, orderable,
sortable: {defaultValue: 'name', possibleValues: 'name, type, cost, usage, costperuse, percent'},
pageable: {maxCountValue: 1000, defaultCountValue: 100}]
responses:
200:
description: OK
body:
application/vnd.api+json:
description: Package resources cost-per-use data
type: resourceCostPerUseCollection
example:
strict: false
value: !include examples/costPerUse/package_resources_cost_per_use_200_response.json
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/costPerUse/cost_per_use_400_response.json
422:
description: Unprocessable Entity
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/costPerUse/cost_per_use_422_response.json