Bug 19618: Add api endpoint for club holds
[koha.git] / api / v1 / swagger / definitions / checkout.json
1 {
2   "type": "object",
3   "properties": {
4     "checkout_id": {
5       "type": "integer",
6       "description": "internally assigned checkout identifier"
7     },
8     "patron_id": {
9       "$ref": "../x-primitives.json#/patron_id"
10     },
11     "item_id": {
12       "type": "integer",
13       "description": "internal identifier of checked out item"
14     },
15     "due_date": {
16       "type": "string",
17       "format": "date-time",
18       "description": "Due date"
19     },
20     "library_id": {
21       "type": ["string", "null"],
22       "description": "code of the library the item was checked out"
23     },
24     "checkin_date": {
25       "type": ["string", "null"],
26       "format": "date",
27       "description": "Date the item was returned"
28     },
29     "last_renewed_date": {
30       "type": ["string", "null"],
31       "format": "date-time",
32       "description": "Date the item was last renewed"
33     },
34     "renewals": {
35       "type": ["integer", "null"],
36       "description": "Number of renewals"
37     },
38     "auto_renew": {
39       "type": "boolean",
40       "description": "Auto renewal"
41     },
42     "auto_renew_error": {
43       "type": ["string", "null"],
44       "description": "Auto renewal error"
45     },
46     "timestamp": {
47       "type": "string",
48       "description": "Last update time"
49     },
50     "checkout_date": {
51       "type": "string",
52       "format": "date-time",
53       "description": "Date the item was issued"
54     },
55     "onsite_checkout": {
56       "type": "boolean",
57       "description": "On site checkout"
58     },
59     "note": {
60       "type": ["string", "null"],
61       "description": "Issue note text"
62     },
63     "note_date": {
64       "type": ["string", "null"],
65       "format": "date",
66       "description": "Datetime of the issue note"
67     }
68   }
69 }