api/v1/swagger/paths/erm_eholdings_resources.yaml

   1 ---
   2 /erm/eholdings/resources:
   3   get:
   4     x-mojo-to: ERM::EHoldings::Resources#list
   5     operationId: listErmEHoldingsResources
   6     tags:
   7       - eholdings
   8     summary: List eholdings resources
   9     produces:
  10       - application/json
  11     parameters:
  12       - description: Case insensitive search on resource_id
  13         in: query
  14         name: resource_id
  15         required: false
  16         type: string
  17       - description: Case insensitive search on package_id
  18         in: query
  19         name: package_id
  20         required: false
  21         type: string
  22       - description: Case insensitive search on title vendor_id
  23         in: query
  24         name: vendor_id
  25         required: false
  26         type: integer
  27       - description: Case insensitive search on started_on
  28         in: query
  29         name: started_on
  30         required: false
  31         type: string
  32       - description: Case insensitive search on ended_on
  33         in: query
  34         name: ended_on
  35         required: false
  36         type: string
  37       - description: Case insensitive search on proxy
  38         in: query
  39         name: proxy
  40         required: false
  41         type: string
  42       - $ref: "../swagger.yaml#/parameters/match"
  43       - $ref: "../swagger.yaml#/parameters/order_by"
  44       - $ref: "../swagger.yaml#/parameters/page"
  45       - $ref: "../swagger.yaml#/parameters/per_page"
  46       - $ref: "../swagger.yaml#/parameters/q_param"
  47       - $ref: "../swagger.yaml#/parameters/q_body"
  48       - $ref: "../swagger.yaml#/parameters/q_header"
  49     responses:
  50       200:
  51         description: A list of eHoldings resources
  52         schema:
  53           items:
  54             $ref: "../swagger.yaml#/definitions/erm_eholdings_resource"
  55           type: array
  56       400:
  57         description: Bad request
  58         schema:
  59           $ref: "../swagger.yaml#/definitions/error"
  60       403:
  61         description: Access forbidden
  62         schema:
  63           $ref: "../swagger.yaml#/definitions/error"
  64       500:
  65         description: |-
  66           Internal server error. Possible `error_code` attribute values:
  67           * `internal_server_error`
  68         schema:
  69           $ref: "../swagger.yaml#/definitions/error"
  70       503:
  71         description: Under maintenance
  72         schema:
  73           $ref: "../swagger.yaml#/definitions/error"
  74     x-koha-authorization:
  75       permissions:
  76         erm: 1
  77 "/erm/eholdings/resources/{resource_id}":
  78   get:
  79     x-mojo-to: ERM::EHoldings::Resources#get
  80     operationId: getErmEHoldingsResources
  81     tags:
  82       - eholdings
  83     summary: Get resources
  84     produces:
  85       - application/json
  86     parameters:
  87       - $ref: "../swagger.yaml#/parameters/eholdings_resource_id_pp"
  88     responses:
  89       200:
  90         description: An eHolding resource
  91         schema:
  92           items:
  93             $ref: "../swagger.yaml#/definitions/erm_eholdings_resource"
  94       401:
  95         description: Authentication required
  96         schema:
  97           $ref: "../swagger.yaml#/definitions/error"
  98       403:
  99         description: Access forbidden
 100         schema:
 101           $ref: "../swagger.yaml#/definitions/error"
 102       404:
 103         description: Ressource not found
 104         schema:
 105           $ref: "../swagger.yaml#/definitions/error"
 106       500:
 107         description: |-
 108           Internal server error. Possible `error_code` attribute values:
 109           * `internal_server_error`
 110         schema:
 111           $ref: "../swagger.yaml#/definitions/error"
 112       503:
 113         description: Under maintenance
 114         schema:
 115           $ref: "../swagger.yaml#/definitions/error"
 116     x-koha-authorization:
 117       permissions:
 118         erm: 1
 119     x-koha-embed:
 120       - resources
 121       - resources.package