Koha-clms/api/v1/swagger/definitions/booking.yaml

79 lines
1.9 KiB
YAML

---
additionalProperties: false
properties:
biblio_id:
description: Internal identifier for the parent bibliographic record
type: integer
biblio:
description: Embedable biblio representation
type: object
booking_id:
description: Internal booking identifier
type: integer
cancellation_reason:
description: Booking cancellation reason
type:
- string
- 'null'
creation_date:
description: Creation date and time of this booking
readOnly: true
format: date-time
type: string
end_date:
description: Start date and time of this booking
format: date-time
type: string
item_id:
description: Internal item identifier for specific item bookings
type:
- integer
- 'null'
itemtype_id:
description: Item type identifier for "any item" bookings. Either item_id or itemtype_id must be provided. This is used for server-side optimal item selection and is not persisted.
type:
- string
- 'null'
item:
description: Embedable item representation
type:
- object
- 'null'
modification_date:
description: Modification date and time of this booking
readOnly: true
format: date-time
type: string
patron_id:
description: Internal patron identifier
type: integer
patron:
description: Embedable patron representation
type:
- object
- 'null'
pickup_library_id:
description: Internal pickup_library identifier
type: string
pickup_library:
description: Embedable pickup_library representation
type:
- object
- 'null'
start_date:
description: Start date and time of this booking
format: date-time
type: string
status:
description: Status of the booking
type:
- string
- 'null'
required:
- biblio_id
- patron_id
- pickup_library_id
- start_date
- end_date
type: object