Tomas Cohen Arazi
4ce7ce2a15
This patch adds the `cancellation_requested` attribute to the hold
object definition, and allows embeding it as on the different holds
endpoints that migt be useful.
To test:
1. Apply this patches
2. Run:
$ kshell
k$ prove t/db_dependent/Koha/Hold.t \
t/db_dependent/api/v1/*holds.t
=> SUCCESS: Tests pass!
3. Play with your REST tool (Postman?) on the following endpoints:
GET http://localhost:8081/api/v1/holds
GET http://localhost:8081/api/v1/patrons/:patron_id/holds
on both, pass and not pass the `x-koha-embed` header with
`cancellation_requested` on it.
=> SUCCESS: It is easy! You see the attribute and you don't, and the
content makes sense!
4. Sign off :-D
Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
112 lines
2.5 KiB
YAML
112 lines
2.5 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
|
|
cancellation_requested:
|
|
type:
|
|
- boolean
|
|
- "null"
|
|
description: Cancellation requests count for the hold (x-koha-embed)
|
|
|
|
additionalProperties: false
|