koha-dev.rot13.org Git - srvgit/blob - api/v1/swagger/paths/erm_eholdings_packages_resources.yaml

   1 ---
   2 /erm/eholdings/{provider}/packages/{package_id}/resources:
   3   get:
   4     x-mojo-to: ERM::EHoldings::Resources#list
   5     operationId: listErmEHoldingsPackagesResources
   6     tags:
   7       - eholdings
   8     summary: List eholdings resources
   9     produces:
  10       - application/json
  11     parameters:
  12       - description: Provider name
  13         in: path
  14         name: provider
  15         required: true
  16         type: string
  17       - description: Case insensitive search on resource_id
  18         in: query
  19         name: resource_id
  20         required: false
  21         type: string
  22       - description: Case insensitive search on started_on
  23         in: query
  24         name: started_on
  25         required: false
  26         type: string
  27       - description: Case insensitive search on ended_on
  28         in: query
  29         name: ended_on
  30         required: false
  31         type: string
  32       - description: Case insensitive search on proxy
  33         in: query
  34         name: proxy
  35         required: false
  36         type: string
  37       - $ref: "../swagger.yaml#/parameters/eholdings_package_id_pp"
  38       - $ref: "../swagger.yaml#/parameters/match"
  39       - $ref: "../swagger.yaml#/parameters/order_by"
  40       - $ref: "../swagger.yaml#/parameters/page"
  41       - $ref: "../swagger.yaml#/parameters/per_page"
  42       - $ref: "../swagger.yaml#/parameters/q_param"
  43       - $ref: "../swagger.yaml#/parameters/q_body"
  44       - $ref: "../swagger.yaml#/parameters/q_header"
  45       - name: x-koha-embed
  46         in: header
  47         required: false
  48         description: Embed list sent as a request header
  49         type: array
  50         items:
  51           type: string
  52           enum:
  53             - title
  54         collectionFormat: csv
  55     responses:
  56       200:
  57         description: A list of eHoldings resources
  58         schema:
  59           items:
  60             $ref: "../swagger.yaml#/definitions/erm_eholdings_resource"
  61           type: array
  62       400:
  63         description: Bad request
  64         schema:
  65           $ref: "../swagger.yaml#/definitions/error"
  66       403:
  67         description: Access forbidden
  68         schema:
  69           $ref: "../swagger.yaml#/definitions/error"
  70       500:
  71         description: |-
  72           Internal server error. Possible `error_code` attribute values:
  73           * `internal_server_error`
  74         schema:
  75           $ref: "../swagger.yaml#/definitions/error"
  76       503:
  77         description: Under maintenance
  78         schema:
  79           $ref: "../swagger.yaml#/definitions/error"
  80     x-koha-authorization:
  81       permissions:
  82         erm: 1