148 lines
3.8 KiB
YAML
148 lines
3.8 KiB
YAML
---
|
|
/items:
|
|
get:
|
|
x-mojo-to: Items#list
|
|
operationId: listItems
|
|
tags:
|
|
- items
|
|
summary: List items
|
|
parameters:
|
|
- name: external_id
|
|
in: query
|
|
description: Search on the item's barcode
|
|
required: false
|
|
type: string
|
|
- $ref: ../parameters.yaml#/match
|
|
- $ref: ../parameters.yaml#/order_by
|
|
- $ref: ../parameters.yaml#/page
|
|
- $ref: ../parameters.yaml#/per_page
|
|
- $ref: ../parameters.yaml#/q_param
|
|
- $ref: ../parameters.yaml#/q_body
|
|
- $ref: ../parameters.yaml#/q_header
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A list of item
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../definitions.yaml#/item
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal server error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
catalogue: "1"
|
|
"/items/{item_id}":
|
|
get:
|
|
x-mojo-to: Items#get
|
|
operationId: getItem
|
|
tags:
|
|
- items
|
|
summary: Get item
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/item_id_pp
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: An item
|
|
schema:
|
|
$ref: ../definitions.yaml#/item
|
|
"400":
|
|
description: Missing or wrong parameters
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Item not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal server error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
catalogue: "1"
|
|
"/items/{item_id}/pickup_locations":
|
|
get:
|
|
x-mojo-to: Items#pickup_locations
|
|
operationId: getItemPickupLocations
|
|
summary: Get valid pickup locations for an item
|
|
tags:
|
|
- items
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/item_id_pp
|
|
- name: patron_id
|
|
in: query
|
|
description: Internal patron identifier
|
|
required: true
|
|
type: integer
|
|
- $ref: ../parameters.yaml#/match
|
|
- $ref: ../parameters.yaml#/order_by
|
|
- $ref: ../parameters.yaml#/page
|
|
- $ref: ../parameters.yaml#/per_page
|
|
- $ref: ../parameters.yaml#/q_param
|
|
- $ref: ../parameters.yaml#/q_body
|
|
- $ref: ../parameters.yaml#/q_header
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Item pickup locations
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../definitions.yaml#/library
|
|
"400":
|
|
description: Missing or wrong parameters
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Biblio not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal server error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
reserveforothers: place_holds
|