4 x-mojo-to: ERM::Agreements#list
5 operationId: listErmAgreements
8 summary: List agreements
12 - description: Case insensitive search on agreement agreement_id
17 - description: Case insensitive search on agreement vendor_id
22 - description: Case insensitive search on agreement name
27 - description: Case insensitive search on agreement description
32 - description: Case insensitive search on agreement status
37 - description: Case insensitive search on agreement closure_reason
42 - description: Case insensitive search on agreement is_perpetual
47 - description: Case insensitive search on agreement renewal_priority
49 name: renewal_priority
52 - description: Case insensitive search on agreement license_info
57 - description: filter by expired agreements
59 name: max_expiration_date
62 - $ref: "../swagger.yaml#/parameters/match"
63 - $ref: "../swagger.yaml#/parameters/order_by"
64 - $ref: "../swagger.yaml#/parameters/page"
65 - $ref: "../swagger.yaml#/parameters/per_page"
66 - $ref: "../swagger.yaml#/parameters/q_param"
67 - $ref: "../swagger.yaml#/parameters/q_body"
68 - $ref: "../swagger.yaml#/parameters/q_header"
71 description: A list of agreement
74 $ref: "../swagger.yaml#/definitions/erm_agreement"
77 description: Bad request
79 $ref: "../swagger.yaml#/definitions/error"
81 description: Access forbidden
83 $ref: "../swagger.yaml#/definitions/error"
86 Internal server error. Possible `error_code` attribute values:
87 * `internal_server_error`
89 $ref: "../swagger.yaml#/definitions/error"
91 description: Under maintenance
93 $ref: "../swagger.yaml#/definitions/error"
98 x-mojo-to: ERM::Agreements#add
99 operationId: addErmAgreements
102 summary: Add agreement
108 - description: A JSON object containing information about the new agreement
113 $ref: "../swagger.yaml#/definitions/erm_agreement"
116 description: A successfully created agreement
119 $ref: "../swagger.yaml#/definitions/erm_agreement"
121 description: Bad parameter
123 $ref: "../swagger.yaml#/definitions/error"
125 description: Authentication required
127 $ref: "../swagger.yaml#/definitions/error"
129 description: Access forbidden
131 $ref: "../swagger.yaml#/definitions/error"
133 description: Ressource not found
135 $ref: "../swagger.yaml#/definitions/error"
137 description: Conflict in creating resource
139 $ref: "../swagger.yaml#/definitions/error"
141 description: Payload too large
143 $ref: "../swagger.yaml#/definitions/error"
146 Internal server error. Possible `error_code` attribute values:
147 * `internal_server_error`
149 $ref: "../swagger.yaml#/definitions/error"
151 description: Under maintenance
153 $ref: "../swagger.yaml#/definitions/error"
154 x-koha-authorization:
157 "/erm/agreements/{agreement_id}":
159 x-mojo-to: ERM::Agreements#get
160 operationId: getErmAgreements
163 summary: Get agreement
167 - $ref: "../swagger.yaml#/parameters/agreement_id_pp"
170 description: An agreement
173 $ref: "../swagger.yaml#/definitions/erm_agreement"
175 description: Authentication required
177 $ref: "../swagger.yaml#/definitions/error"
179 description: Access forbidden
181 $ref: "../swagger.yaml#/definitions/error"
183 description: Ressource not found
185 $ref: "../swagger.yaml#/definitions/error"
188 Internal server error. Possible `error_code` attribute values:
189 * `internal_server_error`
191 $ref: "../swagger.yaml#/definitions/error"
193 description: Under maintenance
195 $ref: "../swagger.yaml#/definitions/error"
196 x-koha-authorization:
204 - agreement_licenses.license
205 - agreement_relationships
206 - agreement_relationships.agreement
207 - agreement_relationships.related_agreement
211 x-mojo-to: ERM::Agreements#update
212 operationId: updateErmAgreements
215 summary: Update agreement
221 - $ref: "../swagger.yaml#/parameters/agreement_id_pp"
224 description: A JSON object containing new information about existing agreement
227 $ref: "../swagger.yaml#/definitions/erm_agreement"
231 description: A successfully updated agreement
234 $ref: "../swagger.yaml#/definitions/erm_agreement"
236 description: Bad parameter
238 $ref: "../swagger.yaml#/definitions/error"
240 description: Access forbidden
242 $ref: "../swagger.yaml#/definitions/error"
244 description: Ressource not found
246 $ref: "../swagger.yaml#/definitions/error"
248 description: Conflict in updating resource
250 $ref: "../swagger.yaml#/definitions/error"
252 description: Payload too large
254 $ref: "../swagger.yaml#/definitions/error"
257 Internal server error. Possible `error_code` attribute values:
258 * `internal_server_error`
260 $ref: "../swagger.yaml#/definitions/error"
262 description: Under maintenance
264 $ref: "../swagger.yaml#/definitions/error"
265 x-koha-authorization:
272 - agreement_relationships
275 x-mojo-to: ERM::Agreements#delete
276 operationId: deleteErmAgreements
279 summary: Delete agreement
283 - $ref: "../swagger.yaml#/parameters/agreement_id_pp"
286 description: Agreement deleted
288 description: Agreement deletion failed
290 $ref: "../swagger.yaml#/definitions/error"
292 description: Authentication required
294 $ref: "../swagger.yaml#/definitions/error"
296 description: Access forbidden
298 $ref: "../swagger.yaml#/definitions/error"
300 description: Ressource not found
302 $ref: "../swagger.yaml#/definitions/error"
304 description: Conflict in deleting resource
306 $ref: "../swagger.yaml#/definitions/error"
309 Internal server error. Possible `error_code` attribute values:
310 * `internal_server_error`
312 $ref: "../swagger.yaml#/definitions/error"
314 description: Under maintenance
316 $ref: "../swagger.yaml#/definitions/error"
317 x-koha-authorization: