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       - name: x-koha-embed
  41         in: header
  42         required: false
  43         description: Embed list sent as a request header
  44         type: array
  45         items:
  46           type: string
  47           enum:
  48             - title.publication_title
  49         collectionFormat: csv
  50     responses:
  51       200:
  52         description: A list of eHoldings resources
  53         schema:
  54           items:
  55             $ref: "../swagger.yaml#/definitions/erm_eholdings_resource"
  56           type: array
  57       400:
  58         description: Bad request
  59         schema:
  60           $ref: "../swagger.yaml#/definitions/error"
  61       403:
  62         description: Access forbidden
  63         schema:
  64           $ref: "../swagger.yaml#/definitions/error"
  65       500:
  66         description: |-
  67           Internal server error. Possible `error_code` attribute values:
  68           * `internal_server_error`
  69         schema:
  70           $ref: "../swagger.yaml#/definitions/error"
  71       503:
  72         description: Under maintenance
  73         schema:
  74           $ref: "../swagger.yaml#/definitions/error"
  75     x-koha-authorization:
  76       permissions:
  77         erm: 1