api/v1/swagger/paths/erm_usage_titles.yaml

   1 ---
   2 /erm/usage_titles:
   3   get:
   4     x-mojo-to: ERM::UsageTitles#list
   5     operationId: listErmUsageTitles
   6     tags:
   7       - usage_title
   8     summary: List usage_titles
   9     produces:
  10       - application/json
  11     parameters:
  12       - description: Case insensitive search on usage_title title_id
  13         in: query
  14         name: title_id
  15         required: false
  16         type: integer
  17       - description: Case insensitive search on usage_title title
  18         in: query
  19         name: title
  20         required: false
  21         type: string
  22       - description: Case insensitive search on usage_title usage_data_provider_id
  23         in: query
  24         name: usage_data_provider_id
  25         required: false
  26         type: string
  27       - description: Case insensitive search on usage_title title_doi
  28         in: query
  29         name: title_doi
  30         required: false
  31         type: string
  32       - description: Case insensitive search on usage_title print_issn
  33         in: query
  34         name: print_issn
  35         required: false
  36         type: string
  37       - description: Case insensitive search on usage_title online_issn
  38         in: query
  39         name: online_issn
  40         required: false
  41         type: string
  42       - description: Case insensitive search on usage_title title_uri
  43         in: query
  44         name: title_uri
  45         required: false
  46         type: string
  47       - name: x-koha-embed
  48         in: header
  49         required: false
  50         description: Embed list sent as a request header
  51         type: array
  52         items:
  53           type: string
  54           enum:
  55             - erm_usage_muses
  56             - erm_usage_yuses
  57         collectionFormat: csv
  58       - $ref: "../swagger.yaml#/parameters/match"
  59       - $ref: "../swagger.yaml#/parameters/order_by"
  60       - $ref: "../swagger.yaml#/parameters/page"
  61       - $ref: "../swagger.yaml#/parameters/per_page"
  62       - $ref: "../swagger.yaml#/parameters/q_param"
  63       - $ref: "../swagger.yaml#/parameters/q_body"
  64       - $ref: "../swagger.yaml#/parameters/q_header"
  65       - $ref: "../swagger.yaml#/parameters/request_id_header"
  66     responses:
  67       200:
  68         description: A list of usage_titles
  69         schema:
  70           items:
  71             $ref: "../swagger.yaml#/definitions/erm_usage_title"
  72           type: array
  73       400:
  74         description: Bad request
  75         schema:
  76           $ref: "../swagger.yaml#/definitions/error"
  77       403:
  78         description: Access forbidden
  79         schema:
  80           $ref: "../swagger.yaml#/definitions/error"
  81       500:
  82         description: |-
  83           Internal server error. Possible `error_code` attribute values:
  84           * `internal_server_error`
  85         schema:
  86           $ref: "../swagger.yaml#/definitions/error"
  87       503:
  88         description: Under maintenance
  89         schema:
  90           $ref: "../swagger.yaml#/definitions/error"
  91     x-koha-authorization:
  92       permissions:
  93         erm: 1