Bug 27251: Rewrite QOTD with the Koha REST API
[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     "issuer_id": {
25       "type": [ "integer", "null" ],
26       "description": "internally assigned for the user that processed the checkout"
27     },
28     "checkin_date": {
29       "type": ["string", "null"],
30       "format": "date-time",
31       "description": "Date the item was returned"
32     },
33     "last_renewed_date": {
34       "type": ["string", "null"],
35       "format": "date-time",
36       "description": "Date the item was last renewed"
37     },
38     "renewals": {
39       "type": ["integer", "null"],
40       "description": "Number of renewals"
41     },
42     "unseen_renewals": {
43       "type": ["integer", "null"],
44       "description": "Number of consecutive unseen renewals"
45     },
46     "auto_renew": {
47       "type": "boolean",
48       "description": "Auto renewal"
49     },
50     "auto_renew_error": {
51       "type": ["string", "null"],
52       "description": "Auto renewal error"
53     },
54     "timestamp": {
55       "type": "string",
56       "description": "Last update time"
57     },
58     "checkout_date": {
59       "type": "string",
60       "format": "date-time",
61       "description": "Date the item was issued"
62     },
63     "onsite_checkout": {
64       "type": "boolean",
65       "description": "On site checkout"
66     },
67     "note": {
68       "type": ["string", "null"],
69       "description": "Issue note text"
70     },
71     "note_date": {
72       "type": ["string", "null"],
73       "format": "date",
74       "description": "Datetime of the issue note"
75     },
76     "issuer": {
77       "type": [
78           "object",
79           "null"
80       ],
81       "description": "The object representing the checkout issuer"
82   }
83 }
84 }