Koha/api/v1/swagger/definitions/hold.yaml
Katrin Fischer 0c21559fcc
Bug 24860: (QA follow-up) Terminology and translation fixes
* Fixes a single to a double underscore for translation in holds.js
* Fixes item_group to item group in API description
* Fixes volume hold to item group hold in syspref db descrpitions

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2022-11-04 19:39:58 -03:00

106 lines
2.4 KiB
YAML

---
type: object
properties:
hold_id:
type: integer
description: Internal hold identifier
patron_id:
type: integer
description: Internal patron identifier
hold_date:
type:
- string
- "null"
format: date
description: The date the hold was placed
biblio_id:
type: integer
description: Internal biblio identifier
item_group_id:
type:
- string
- "null"
description: Internal item group identifier
pickup_library_id:
type:
- string
- "null"
description: Internal library identifier for the pickup library
desk_id:
type:
- integer
- "null"
description: The id of the desk
cancellation_date:
type:
- string
- "null"
format: date
description: The date the hold was cancelled
cancellation_reason:
type:
- string
- "null"
description: The reason the hold was cancelled
notes:
type:
- string
- "null"
description: Notes related to this hold
priority:
type:
- integer
- "null"
description: Where in the queue the patron sits
status:
type:
- string
- "null"
description: A one letter code defining what the status of the hold is after it has
been confirmed
timestamp:
type: string
format: date-time
description: Timestamp for the latest hold update
item_id:
type:
- string
- "null"
description: Internal item identifier
waiting_date:
type:
- string
- "null"
format: date
description: The date the item was marked as waiting for the patron at the library
expiration_date:
type:
- string
- "null"
format: date
description: The date the hold expires
lowest_priority:
type: boolean
description: Controls if the hold is given the lowest priority on the queue
suspended:
type: boolean
description: Controls if the hold is suspended
suspended_until:
type:
- string
- "null"
format: date-time
description: Date until which the hold has been suspended
non_priority:
description: Set this hold as non priority
type: boolean
item_type:
type:
- string
- "null"
description: If record level hold, the optional itemtype of the item the patron is
requesting
item_level:
type: boolean
description: If the hold is placed at item level
additionalProperties: false