Bug 13903: Add API routes to list, create, update, delete reserves
[koha.git] / api / v1 / definitions / hold.json
1 {
2     "type": "object",
3     "properties": {
4         "reserve_id": {
5             "description": "Internal hold identifier"
6         },
7         "borrowernumber": {
8             "type": "string",
9             "description": "internally assigned user identifier"
10         },
11         "reservedate": {
12             "description": "the date the hold was placed"
13         },
14         "biblionumber": {
15             "type": "string",
16             "description": "internally assigned biblio identifier"
17         },
18         "branchcode": {
19             "type": ["string", "null"],
20             "description": "internally assigned branch identifier"
21         },
22         "notificationdate": {
23             "description": "currently unused"
24         },
25         "reminderdate": {
26             "description": "currently unused"
27         },
28         "cancellationdate": {
29             "description": "the date the hold was cancelled"
30         },
31         "reservenotes": {
32             "description": "notes related to this hold"
33         },
34         "priority": {
35             "description": "where in the queue the patron sits"
36         },
37         "found": {
38             "description": "a one letter code defining what the status of the hold is after it has been confirmed"
39         },
40         "timestamp": {
41             "description": "date and time the hold was last updated"
42         },
43         "itemnumber": {
44             "type": ["string", "null"],
45             "description": "internally assigned item identifier"
46         },
47         "waitingdate": {
48             "description": "the date the item was marked as waiting for the patron at the library"
49         },
50         "expirationdate": {
51             "description": "the date the hold expires"
52         },
53         "lowestPriority": {
54             "description": ""
55         },
56         "suspend": {
57             "description": ""
58         },
59         "suspend_until": {
60             "description": ""
61         }
62     }
63 }