Koha/api/v1/swagger/definitions/hold.json
Tomas Cohen Arazi 62f1b2df68 Bug 20006: Spec changes
This patch makes the spec match the voted RFC.

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
2019-03-15 19:35:26 +00:00

79 lines
2.2 KiB
JSON

{
"type": "object",
"properties": {
"hold_id": {
"type": "integer",
"description": "Internal hold identifier"
},
"patron_id": {
"type": "integer",
"description": "Internal patron identifier"
},
"hold_date": {
"type": ["string", "null"],
"format": "date",
"description": "The date the hold was placed"
},
"biblio_id": {
"type": "integer",
"description": "Internal biblio identifier"
},
"pickup_library_id": {
"type": ["string", "null"],
"description": "Internal library identifier for the pickup library"
},
"cancelation_date": {
"type": ["string", "null"],
"format": "date",
"description": "The date the hold was cancelled"
},
"notes": {
"type": ["string", "null"],
"description": "Notes related to this hold"
},
"priority": {
"type": ["integer", "null"],
"description": "Where in the queue the patron sits"
},
"status": {
"type": ["string", "null"],
"description": "A one letter code defining what the status of the hold is after it has been confirmed"
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp for the latest hold update"
},
"item_id": {
"type": ["string", "null"],
"description": "Internal item identifier"
},
"waiting_date": {
"type": ["string", "null"],
"format": "date",
"description": "The date the item was marked as waiting for the patron at the library"
},
"expiration_date": {
"type": ["string", "null"],
"format": "date",
"description": "The date the hold expires"
},
"lowest_priority": {
"type": "boolean",
"description": "Controls if the hold is given the lowest priority on the queue"
},
"suspended": {
"type": "boolean",
"description": "Controls if the hold is suspended"
},
"suspended_until": {
"type": ["string", "null"],
"format": "date-time",
"description": "Date until which the hold has been suspended"
},
"item_type": {
"type": ["string", "null"],
"description": "If record level hold, the optional itemtype of the item the patron is requesting"
}
}
}