Koha/api/v1/swagger/definitions/checkout.json
Josef Moravec 321b1c1f3c
Bug 17005: Add checked_in checkouts to REST API response
This patch implements parameter 'checked_in' on checkouts endpoint to
enable getting circulation history.

Test plan:
1) Apply the patch and restart plack
2) Use your favorite REST API tester and play with /checkouts endpoint:
    - use it without checked_in parameter
    - use checked_in=1 for getting returned checkouts

Signed-off-by: Michal Denar <black23@gmail.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2019-10-08 14:33:39 +01:00

69 lines
1.7 KiB
JSON

{
"type": "object",
"properties": {
"checkout_id": {
"type": "integer",
"description": "internally assigned checkout identifier"
},
"patron_id": {
"$ref": "../x-primitives.json#/patron_id"
},
"item_id": {
"type": "integer",
"description": "internal identifier of checked out item"
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Due date"
},
"library_id": {
"type": ["string", "null"],
"description": "code of the library the item was checked out"
},
"checkin_date": {
"type": ["string", "null"],
"format": "date-time",
"description": "Date the item was returned"
},
"last_renewed_date": {
"type": ["string", "null"],
"format": "date-time",
"description": "Date the item was last renewed"
},
"renewals": {
"type": ["integer", "null"],
"description": "Number of renewals"
},
"auto_renew": {
"type": "boolean",
"description": "Auto renewal"
},
"auto_renew_error": {
"type": ["string", "null"],
"description": "Auto renewal error"
},
"timestamp": {
"type": "string",
"description": "Last update time"
},
"checkout_date": {
"type": "string",
"format": "date-time",
"description": "Date the item was issued"
},
"onsite_checkout": {
"type": "boolean",
"description": "On site checkout"
},
"note": {
"type": ["string", "null"],
"description": "Issue note text"
},
"note_date": {
"type": ["string", "null"],
"format": "date",
"description": "Datetime of the issue note"
}
}
}