Jonathan Druart
4a38660680
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Séverine Queune <severine.queune@bulac.fr> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
151 lines
4.4 KiB
YAML
151 lines
4.4 KiB
YAML
---
|
|
/acquisitions/funds:
|
|
get:
|
|
x-mojo-to: Acquisitions::Funds#list
|
|
operationId: listFunds
|
|
tags:
|
|
- funds
|
|
summary: List funds
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- name: name
|
|
in: query
|
|
description: Case insensitive search on fund name
|
|
required: false
|
|
type: string
|
|
- name: fund_owner_id
|
|
in: query
|
|
description: Display only the funds that belongs to the given patron ID
|
|
required: false
|
|
type: integer
|
|
- $ref: "../swagger.yaml#/parameters/match"
|
|
- $ref: "../swagger.yaml#/parameters/order_by"
|
|
- $ref: "../swagger.yaml#/parameters/page"
|
|
- $ref: "../swagger.yaml#/parameters/per_page"
|
|
- $ref: "../swagger.yaml#/parameters/q_param"
|
|
- $ref: "../swagger.yaml#/parameters/q_body"
|
|
- $ref: "../swagger.yaml#/parameters/q_header"
|
|
responses:
|
|
"200":
|
|
description: A list of funds
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "../swagger.yaml#/definitions/fund"
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"404":
|
|
description: Fund not found
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"500":
|
|
description: |
|
|
Internal server error. Possible `error_code` attribute values:
|
|
|
|
* `internal_server_error`
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
x-koha-authorization:
|
|
permissions:
|
|
acquisition: budget_manage_all
|
|
/acquisitions/funds/owners:
|
|
get:
|
|
x-mojo-to: Acquisitions::Funds#list_owners
|
|
operationId: listFundsOwners
|
|
description: This resource returns a list of patron allowed to be owner of funds
|
|
summary: List possibe owners for funds
|
|
tags:
|
|
- funds
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/match
|
|
- $ref: ../parameters.yaml#/order_by
|
|
- $ref: ../parameters.yaml#/page
|
|
- $ref: ../parameters.yaml#/per_page
|
|
- $ref: ../parameters.yaml#/q_param
|
|
- $ref: ../parameters.yaml#/q_body
|
|
- $ref: ../parameters.yaml#/q_header
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A list of funds' owners
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../definitions.yaml#/patron
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: |
|
|
Internal server error. Possible `error_code` attribute values:
|
|
|
|
* `internal_server_error`
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
acquisition: budget_modify
|
|
x-koha-embed:
|
|
- extended_attributes
|
|
/acquisitions/funds/users:
|
|
get:
|
|
x-mojo-to: Acquisitions::Funds#list_users
|
|
operationId: listFundsUsers
|
|
description: This resource returns a list of patron allowed to be owner of funds
|
|
summary: List possibe users for funds
|
|
tags:
|
|
- funds
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/match
|
|
- $ref: ../parameters.yaml#/order_by
|
|
- $ref: ../parameters.yaml#/page
|
|
- $ref: ../parameters.yaml#/per_page
|
|
- $ref: ../parameters.yaml#/q_param
|
|
- $ref: ../parameters.yaml#/q_body
|
|
- $ref: ../parameters.yaml#/q_header
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A list of funds' users
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../definitions.yaml#/patron
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: |
|
|
Internal server error. Possible `error_code` attribute values:
|
|
|
|
* `internal_server_error`
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
acquisition: budget_modify
|
|
x-koha-embed:
|
|
- extended_attributes
|