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

   1 ---
   2 /erm/eholdings/{provider}/titles/{title_id}/resources:
   3   get:
   4     x-mojo-to: ERM::EHoldings::Resources#list
   5     operationId: listErmEHoldingsTitlesResources
   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 started_on
  18         in: query
  19         name: started_on
  20         required: false
  21         type: string
  22       - description: Case insensitive search on ended_on
  23         in: query
  24         name: ended_on
  25         required: false
  26         type: string
  27       - description: Case insensitive search on proxy
  28         in: query
  29         name: proxy
  30         required: false
  31         type: string
  32       - $ref: "../swagger.yaml#/parameters/eholdings_title_id_pp"
  33       - $ref: "../swagger.yaml#/parameters/match"
  34       - $ref: "../swagger.yaml#/parameters/order_by"
  35       - $ref: "../swagger.yaml#/parameters/page"
  36       - $ref: "../swagger.yaml#/parameters/per_page"
  37       - $ref: "../swagger.yaml#/parameters/q_param"
  38       - $ref: "../swagger.yaml#/parameters/q_body"
  39       - $ref: "../swagger.yaml#/parameters/q_header"
  40     responses:
  41       200:
  42         description: A list of eHoldings resources
  43         schema:
  44           items:
  45             $ref: "../swagger.yaml#/definitions/erm_eholdings_resource"
  46           type: array
  47       400:
  48         description: Bad request
  49         schema:
  50           $ref: "../swagger.yaml#/definitions/error"
  51       403:
  52         description: Access forbidden
  53         schema:
  54           $ref: "../swagger.yaml#/definitions/error"
  55       500:
  56         description: |-
  57           Internal server error. Possible `error_code` attribute values:
  58           * `internal_server_error`
  59         schema:
  60           $ref: "../swagger.yaml#/definitions/error"
  61       503:
  62         description: Under maintenance
  63         schema:
  64           $ref: "../swagger.yaml#/definitions/error"
  65     x-koha-authorization:
  66       permissions:
  67         erm: 1
  68     x-koha-embed:
  69       - title.publication_title