|
Line 0
Link Here
|
|
|
1 |
{ |
| 2 |
"description": "An object that contains either none or multiple reasons defined in this object's specification.", |
| 3 |
"type": "object", |
| 4 |
"properties": { |
| 5 |
"Biblio::CheckedOut": { |
| 6 |
"description": "Patron has already checked out an item from this biblio. A confirmation may be required.", |
| 7 |
"type": "object", |
| 8 |
"properties": { |
| 9 |
"biblionumber": { |
| 10 |
"$ref": "../../x-primitives.json#/biblionumber" |
| 11 |
} |
| 12 |
} |
| 13 |
}, |
| 14 |
"Biblio::NoAvailableItems": { |
| 15 |
"description": "This biblio has no available items.", |
| 16 |
"type": "object", |
| 17 |
"properties": {} |
| 18 |
}, |
| 19 |
"Checkout::DueDateBeforeNow": { |
| 20 |
"description": "Given due date is in the past.", |
| 21 |
"type": "object", |
| 22 |
"properties": { |
| 23 |
"duedate": { |
| 24 |
"type": ["string", "null"], |
| 25 |
"format": "date-time" |
| 26 |
}, |
| 27 |
"now": { |
| 28 |
"type": ["string", "null"], |
| 29 |
"format": "date-time" |
| 30 |
} |
| 31 |
} |
| 32 |
}, |
| 33 |
"Checkout::Fee": { |
| 34 |
"description": "Checkout fee will apply.", |
| 35 |
"type": "object", |
| 36 |
"properties": { |
| 37 |
"amount": { |
| 38 |
"type": ["number", "null"], |
| 39 |
"description": "Amount of rental charge." |
| 40 |
} |
| 41 |
} |
| 42 |
}, |
| 43 |
"Checkout::InvalidDueDate": { |
| 44 |
"description": "Given due date is invalid.", |
| 45 |
"type": "object", |
| 46 |
"properties": { |
| 47 |
"duedate": { |
| 48 |
"type": ["string", "null"] |
| 49 |
} |
| 50 |
} |
| 51 |
}, |
| 52 |
"Checkout::MaximumCheckoutsReached": { |
| 53 |
"description": "Maximum number of checkouts have been reached.", |
| 54 |
"type": "object", |
| 55 |
"properties": { |
| 56 |
"max_checkouts_allowed": { |
| 57 |
"type": ["integer", "null"], |
| 58 |
"description": "Maximum number of checkouts allowed." |
| 59 |
}, |
| 60 |
"current_checkout_count": { |
| 61 |
"type": ["integer", "null"], |
| 62 |
"description": "Current checkout count for patron." |
| 63 |
} |
| 64 |
} |
| 65 |
}, |
| 66 |
"Checkout::MaximumOnsiteCheckoutsReached": { |
| 67 |
"description": "Maximum number of on-site checkouts have been reached.", |
| 68 |
"type": "object", |
| 69 |
"properties": { |
| 70 |
"max_onsite_checkouts": { |
| 71 |
"type": ["integer", "null"], |
| 72 |
"description": "Maximum number of onsite checkouts allowed." |
| 73 |
}, |
| 74 |
"current_onsite_checkouts": { |
| 75 |
"type": ["integer", "null"], |
| 76 |
"description": "Current onsite checkout count for patron." |
| 77 |
} |
| 78 |
} |
| 79 |
}, |
| 80 |
"Checkout::NoMoreRenewals": { |
| 81 |
"description": "No more renewals allowed.", |
| 82 |
"type": "object", |
| 83 |
"properties": {} |
| 84 |
}, |
| 85 |
"Checkout::NoMoreRenewalForOnsiteCheckouts": { |
| 86 |
"description": "No more on-site renewals allowed.", |
| 87 |
"type": "object", |
| 88 |
"properties": {} |
| 89 |
}, |
| 90 |
"Checkout::OnsiteCheckoutsDisabled": { |
| 91 |
"description": "On-site checkouts are disabled.", |
| 92 |
"type": "object", |
| 93 |
"properties": {} |
| 94 |
}, |
| 95 |
"Checkout::Renew": { |
| 96 |
"description": "Checkout will be renewed.", |
| 97 |
"type": "object", |
| 98 |
"properties": {} |
| 99 |
}, |
| 100 |
"Checkout::ZeroCheckoutsAllowed": { |
| 101 |
"description": "Allowed number of checkouts is zero.", |
| 102 |
"type": "object", |
| 103 |
"properties": {} |
| 104 |
}, |
| 105 |
"Hold::ItemLevelHoldNotAllowed": { |
| 106 |
"description": "Item-level holds are not allowed.", |
| 107 |
"type": "object", |
| 108 |
"properties": {} |
| 109 |
}, |
| 110 |
"Hold::MaximumHoldsReached": { |
| 111 |
"description": "Maximum number of holds have been reached.", |
| 112 |
"type": "object", |
| 113 |
"properties": { |
| 114 |
"max_holds_allowed": { |
| 115 |
"type": ["integer", "null"] |
| 116 |
}, |
| 117 |
"current_hold_count": { |
| 118 |
"type": ["integer", "null"] |
| 119 |
} |
| 120 |
} |
| 121 |
}, |
| 122 |
"Hold::MaximumHoldsForThisRecordReached": { |
| 123 |
"description": "Maximum number of holds for this record have been reached.", |
| 124 |
"type": "object", |
| 125 |
"properties": { |
| 126 |
"max_holds_allowed": { |
| 127 |
"type": ["integer", "null"] |
| 128 |
}, |
| 129 |
"current_hold_count": { |
| 130 |
"type": ["integer", "null"] |
| 131 |
} |
| 132 |
} |
| 133 |
}, |
| 134 |
"Hold::NotAllowedByLibrary": { |
| 135 |
"description": "Library does not allow holds to be placed.", |
| 136 |
"type": "object", |
| 137 |
"properties": {} |
| 138 |
}, |
| 139 |
"Hold::NotAllowedFromOtherLibraries": { |
| 140 |
"description": "Holds are not allowed from other libraries.", |
| 141 |
"type": "object", |
| 142 |
"properties": {} |
| 143 |
}, |
| 144 |
"Hold::NotAllowedInOPAC": { |
| 145 |
"description": "Patron cannot place a hold by themselves in OPAC.", |
| 146 |
"type": "object", |
| 147 |
"properties": {} |
| 148 |
}, |
| 149 |
"Hold::OnShelfNotAllowed": { |
| 150 |
"description": "On-shelf holds are not allowed.", |
| 151 |
"type": "object", |
| 152 |
"properties": {} |
| 153 |
}, |
| 154 |
"Hold::ZeroHoldsAllowed": { |
| 155 |
"description": "Allowed number of holds is zero.", |
| 156 |
"type": "object", |
| 157 |
"properties": {} |
| 158 |
}, |
| 159 |
"Item::AlreadyHeldForThisPatron": { |
| 160 |
"description": "Item is held for this patron.", |
| 161 |
"type": "object", |
| 162 |
"properties": {} |
| 163 |
}, |
| 164 |
"Item::CannotBeTransferred": { |
| 165 |
"description": "Item cannot be transferred.", |
| 166 |
"type": "object", |
| 167 |
"properties": { |
| 168 |
"from_library": { |
| 169 |
"$ref": "../../x-primitives.json#/branchcode" |
| 170 |
}, |
| 171 |
"to_library": { |
| 172 |
"$ref": "../../x-primitives.json#/branchcode" |
| 173 |
} |
| 174 |
} |
| 175 |
}, |
| 176 |
"Item::CheckedOut": { |
| 177 |
"description": "Item is checked out to a patron.", |
| 178 |
"type": "object", |
| 179 |
"properties": { |
| 180 |
"borrowernumber": { |
| 181 |
"type": ["integer", "null"] |
| 182 |
}, |
| 183 |
"date_due": { |
| 184 |
"type": ["string", "null"], |
| 185 |
"format": "date-time" |
| 186 |
} |
| 187 |
} |
| 188 |
}, |
| 189 |
"Item::Damaged": { |
| 190 |
"description": "Item is marked as damaged", |
| 191 |
"type": "object", |
| 192 |
"properties": {} |
| 193 |
}, |
| 194 |
"Item::FromAnotherLibrary": { |
| 195 |
"description": "Libraries are independent and this item is from another library than current patron.", |
| 196 |
"type": "object", |
| 197 |
"properties": { |
| 198 |
"itemhomebranch": { |
| 199 |
"$ref": "../../x-primitives.json#/branchcode" |
| 200 |
} |
| 201 |
} |
| 202 |
}, |
| 203 |
"Item::Held": { |
| 204 |
"description": "Someone has placed a hold on this item.", |
| 205 |
"type": "object", |
| 206 |
"properties": { |
| 207 |
"borrowernumber": { |
| 208 |
"$ref": "../../x-primitives.json#/borrowernumber" |
| 209 |
}, |
| 210 |
"status": { |
| 211 |
"type": ["string", "null"] |
| 212 |
}, |
| 213 |
"hold_queue_length": { |
| 214 |
"type": ["integer", "null"] |
| 215 |
} |
| 216 |
} |
| 217 |
}, |
| 218 |
"Item::HighHolds": { |
| 219 |
"description": "Loan period shortened for high held item.", |
| 220 |
"type": "object", |
| 221 |
"properties": { |
| 222 |
"num_holds": { |
| 223 |
"type": ["integer", "null"] |
| 224 |
}, |
| 225 |
"duration": { |
| 226 |
"type": ["string", "null"] |
| 227 |
}, |
| 228 |
"returndate": { |
| 229 |
"type": ["string", "null"], |
| 230 |
"format": "date-time" |
| 231 |
} |
| 232 |
} |
| 233 |
}, |
| 234 |
"Item::Lost": { |
| 235 |
"description": "Item is marked as lost.", |
| 236 |
"type": "object", |
| 237 |
"properties": { |
| 238 |
"code": { |
| 239 |
"description": "Status description (e.g. Missing)", |
| 240 |
"type": ["string", "null"] |
| 241 |
}, |
| 242 |
"status": { |
| 243 |
"description": "Item's lost status number", |
| 244 |
"type": ["integer", "null"] |
| 245 |
} |
| 246 |
} |
| 247 |
}, |
| 248 |
"Item::NotForLoan": { |
| 249 |
"description": "Item is not for loan.", |
| 250 |
"type": "object", |
| 251 |
"properties": { |
| 252 |
"status": { |
| 253 |
"description": "Item's notforloan status number", |
| 254 |
"type": ["integer", "null"] |
| 255 |
}, |
| 256 |
"code": { |
| 257 |
"description": "Status description (e.g. Ordered)", |
| 258 |
"type": ["string", "null"] |
| 259 |
} |
| 260 |
} |
| 261 |
}, |
| 262 |
"Item::Restricted": { |
| 263 |
"description": "Item is restricted.", |
| 264 |
"type": "object", |
| 265 |
"properties": {} |
| 266 |
}, |
| 267 |
"Item::Transfer": { |
| 268 |
"description": "Item is being transferred.", |
| 269 |
"type": "object", |
| 270 |
"properties": { |
| 271 |
"from_library": { |
| 272 |
"$ref": "../../x-primitives.json#/branchcode" |
| 273 |
}, |
| 274 |
"to_library": { |
| 275 |
"$ref": "../../x-primitives.json#/branchcode" |
| 276 |
}, |
| 277 |
"datesent": { |
| 278 |
"description": "Start date of transfer", |
| 279 |
"type": ["string", "null"], |
| 280 |
"format": "date-time" |
| 281 |
} |
| 282 |
} |
| 283 |
}, |
| 284 |
"Item::UnknownBarcode": { |
| 285 |
"description": "This item has either an unknown barcode or no barcode at all.", |
| 286 |
"type": "object", |
| 287 |
"properties": { |
| 288 |
"barcode": { |
| 289 |
"type": ["string", "null"] |
| 290 |
} |
| 291 |
} |
| 292 |
}, |
| 293 |
"Item::Withdrawn": { |
| 294 |
"description": "Item is withdrawn.", |
| 295 |
"type": "object", |
| 296 |
"properties": {} |
| 297 |
}, |
| 298 |
"ItemType::NotForLoan": { |
| 299 |
"description": "Item type is not for loan.", |
| 300 |
"type": "object", |
| 301 |
"properties": { |
| 302 |
"status": { |
| 303 |
"description": "Item's notforloan status number", |
| 304 |
"type": ["integer", "null"] |
| 305 |
}, |
| 306 |
"code": { |
| 307 |
"description": "Status description (e.g. Ordered)", |
| 308 |
"type": ["string", "null"] |
| 309 |
}, |
| 310 |
"itemtype": { |
| 311 |
"description": "Item type", |
| 312 |
"type": ["string", "null"] |
| 313 |
} |
| 314 |
} |
| 315 |
}, |
| 316 |
"Patron::AgeRestricted": { |
| 317 |
"description": "An age restriction applies for this patron.", |
| 318 |
"type": "object", |
| 319 |
"properties": { |
| 320 |
"age_restriction": { |
| 321 |
"type": ["string", "null"], |
| 322 |
"description": "Age restriction, e.g. PEGI 16" |
| 323 |
} |
| 324 |
} |
| 325 |
}, |
| 326 |
"Patron::CardExpired": { |
| 327 |
"description": "Patron's card has been expired.", |
| 328 |
"type": "object", |
| 329 |
"properties": { |
| 330 |
"expiration_date": { |
| 331 |
"type": ["string", "null"], |
| 332 |
"format": "date" |
| 333 |
} |
| 334 |
} |
| 335 |
}, |
| 336 |
"Patron::CardLost": { |
| 337 |
"description": "Patron's card has been marked as lost.", |
| 338 |
"type": "object", |
| 339 |
"properties": {} |
| 340 |
}, |
| 341 |
"Patron::Debarred": { |
| 342 |
"description": "Patron is debarred.", |
| 343 |
"type": "object", |
| 344 |
"properties": { |
| 345 |
"expiration_date": { |
| 346 |
"type": ["string", "null"], |
| 347 |
"format": "date" |
| 348 |
}, |
| 349 |
"comment": { |
| 350 |
"type": ["string", "null"] |
| 351 |
} |
| 352 |
} |
| 353 |
}, |
| 354 |
"Patron::DebarredOverdue": { |
| 355 |
"description": "Patron has overdues and is debarred.", |
| 356 |
"type": "object", |
| 357 |
"properties": { |
| 358 |
"number_of_overdues": { |
| 359 |
"type": ["integer", "null"] |
| 360 |
} |
| 361 |
} |
| 362 |
}, |
| 363 |
"Patron::Debt": { |
| 364 |
"description": "Patron's debts exceed maximum allowed amount.", |
| 365 |
"type": "object", |
| 366 |
"properties": { |
| 367 |
"max_outstanding":{ |
| 368 |
"type": ["number", "null"] |
| 369 |
}, |
| 370 |
"current_outstanding": { |
| 371 |
"type": ["number", "null"] |
| 372 |
} |
| 373 |
} |
| 374 |
}, |
| 375 |
"Patron::DebtGuarantees": { |
| 376 |
"description": "Patron's guarantees' debts exceed maximum allowed amount.", |
| 377 |
"type": "object", |
| 378 |
"properties": { |
| 379 |
"max_outstanding":{ |
| 380 |
"type": ["number", "null"] |
| 381 |
}, |
| 382 |
"current_outstanding": { |
| 383 |
"type": ["number", "null"] |
| 384 |
} |
| 385 |
} |
| 386 |
}, |
| 387 |
"Patron::FromAnotherLibrary": { |
| 388 |
"description": "Libraries are independent and patron is from another library than current logged in user.", |
| 389 |
"type": "object", |
| 390 |
"properties": { |
| 391 |
"patron_branch": { |
| 392 |
"$ref": "../../x-primitives.json#/branchcode" |
| 393 |
}, |
| 394 |
"current_branch": { |
| 395 |
"$ref": "../../x-primitives.json#/branchcode" |
| 396 |
} |
| 397 |
} |
| 398 |
}, |
| 399 |
"Patron::GoneNoAddress": { |
| 400 |
"type": "object", |
| 401 |
"properties": {} |
| 402 |
} |
| 403 |
} |
| 404 |
} |