4 x-mojo-to: ERM::Licenses#list
5 operationId: listErmLicenses
8 summary: List licenses for agreements
12 - description: Case insensitive search on license license_id
17 - description: Case insensitive search on agreement vendor_id
22 - description: Case insensitive search on license name
27 - description: Case insensitive search on license type
32 - description: Case insensitive search on license status
37 - description: Case insensitive search on license start date
42 - description: Case insensitive search on license end date
47 - $ref: "../swagger.yaml#/parameters/match"
48 - $ref: "../swagger.yaml#/parameters/order_by"
49 - $ref: "../swagger.yaml#/parameters/page"
50 - $ref: "../swagger.yaml#/parameters/per_page"
51 - $ref: "../swagger.yaml#/parameters/q_param"
52 - $ref: "../swagger.yaml#/parameters/q_body"
53 - $ref: "../swagger.yaml#/parameters/q_header"
56 description: A list of agreements' licenses
59 $ref: "../swagger.yaml#/definitions/erm_license"
62 description: Bad request
64 $ref: "../swagger.yaml#/definitions/error"
66 description: Access forbidden
68 $ref: "../swagger.yaml#/definitions/error"
71 Internal server error. Possible `error_code` attribute values:
72 * `internal_server_error`
74 $ref: "../swagger.yaml#/definitions/error"
76 description: Under maintenance
78 $ref: "../swagger.yaml#/definitions/error"
83 x-mojo-to: ERM::Licenses#add
84 operationId: addERMLicenses
93 - description: A JSON object containing information about the new agreement's license
98 $ref: "../swagger.yaml#/definitions/erm_license"
101 description: A successfully created license
104 $ref: "../swagger.yaml#/definitions/erm_license"
106 description: Bad parameter
108 $ref: "../swagger.yaml#/definitions/error"
110 description: Authentication required
112 $ref: "../swagger.yaml#/definitions/error"
114 description: Access forbidden
116 $ref: "../swagger.yaml#/definitions/error"
118 description: Ressource not found
120 $ref: "../swagger.yaml#/definitions/error"
122 description: Conflict in creating resource
124 $ref: "../swagger.yaml#/definitions/error"
126 description: Payload too large
128 $ref: "../swagger.yaml#/definitions/error"
131 Internal server error. Possible `error_code` attribute values:
132 * `internal_server_error`
134 $ref: "../swagger.yaml#/definitions/error"
136 description: Under maintenance
138 $ref: "../swagger.yaml#/definitions/error"
139 x-koha-authorization:
142 "/erm/licenses/{license_id}":
144 x-mojo-to: ERM::Licenses#get
145 operationId: getERMlicense
152 - $ref: "../swagger.yaml#/parameters/license_id_pp"
156 description: Embed list sent as a request header
165 collectionFormat: csv
171 $ref: "../swagger.yaml#/definitions/erm_license"
173 description: authentication required
175 $ref: "../swagger.yaml#/definitions/error"
177 description: access forbidden
179 $ref: "../swagger.yaml#/definitions/error"
181 description: ressource not found
183 $ref: "../swagger.yaml#/definitions/error"
186 internal server error. possible `error_code` attribute values:
187 * `internal_server_error`
189 $ref: "../swagger.yaml#/definitions/error"
191 description: under maintenance
193 $ref: "../swagger.yaml#/definitions/error"
194 x-koha-authorization:
198 x-mojo-to: ERM::Licenses#update
199 operationId: updateERMlicenses
202 summary: update license
208 - $ref: "../swagger.yaml#/parameters/license_id_pp"
211 description: a json object containing new information about existing license
214 $ref: "../swagger.yaml#/definitions/erm_license"
218 description: Embed list sent as a request header
225 collectionFormat: csv
228 description: a successfully updated license
231 $ref: "../swagger.yaml#/definitions/erm_license"
233 description: bad parameter
235 $ref: "../swagger.yaml#/definitions/error"
237 description: access forbidden
239 $ref: "../swagger.yaml#/definitions/error"
241 description: ressource not found
243 $ref: "../swagger.yaml#/definitions/error"
245 description: conflict in updating resource
247 $ref: "../swagger.yaml#/definitions/error"
249 description: Payload too large
251 $ref: "../swagger.yaml#/definitions/error"
254 internal server error. possible `error_code` attribute values:
255 * `internal_server_error`
257 $ref: "../swagger.yaml#/definitions/error"
259 description: under maintenance
261 $ref: "../swagger.yaml#/definitions/error"
262 x-koha-authorization:
266 x-mojo-to: ERM::Licenses#delete
267 operationId: deleteERMlicenses
270 summary: Delete license
274 - $ref: "../swagger.yaml#/parameters/license_id_pp"
277 description: license deleted
279 description: license deletion failed
281 $ref: "../swagger.yaml#/definitions/error"
283 description: authentication required
285 $ref: "../swagger.yaml#/definitions/error"
287 description: access forbidden
289 $ref: "../swagger.yaml#/definitions/error"
291 description: ressource not found
293 $ref: "../swagger.yaml#/definitions/error"
295 description: conflict in deleting resource
297 $ref: "../swagger.yaml#/definitions/error"
300 internal server error. possible `error_code` attribute values:
301 * `internal_server_error`
303 $ref: "../swagger.yaml#/definitions/error"
305 description: under maintenance
307 $ref: "../swagger.yaml#/definitions/error"
308 x-koha-authorization: