When someone "rents" a LibraryGame one of these is created to keep track of that rental.
Library Game Checkouts are accessed via /api/librarygamecheckout.
See "Object Properties" in Introduction for basic shared properties.
Complete details in LibraryGameCheckoutProperties. It also has the following read-only properties:
The time between the checkout's date_created and checkin_date in minutes.
A flag that will appear (value "1") only if the checkout's checkedout_seconds rounded to minutes is different from the default minutes.
See "Related Objects" in Introduction for how to use them.
The Badge associated with this checkout, if any.
The Convention associated with this checkout, if any.
The Library this library game checkout belongs to.
The LibraryGame this library game checkout belongs to.
The User associated with this checkout, if any.
The services used to fetch and manipulate library game checkouts.
This will search across all libraries. To search on a single library see "Relationships" in Library.
GET /api/librarygamecheckout
Searches a partial renter_name.
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"renter_name" : "Andy Dufresne",
...
},
...
]
}
POST /api/librarygamecheckout
Returns the same as a normal read.
GET /api/librarygamecheckout/xxx
Returns:
{
"id" : "xxx",
"renter_name" : "Andy Dufresne",
...
}
PUT /api/librarygamecheckout/xxx
Returns the same as a normal read.
DELETE /api/librarygamecheckout/xxx
Returns:
{
"success" : 1
}
This returns a game to the library that has been checked out.
POST /api/librarygamecheckout/xxx/checkin
The duration of the check-out time in seconds. Include this if you want the checkedout_seconds to be shorter or longer than the time between the checkout date_created and the checkin_date.
An explanatory note why the checkout time is being changed. This note will be added to the LibraryGame log.
Returns the same as a normal read.
This will change the checkedout_seconds value of the checkout, and make an entry in the LibraryGame log of the change.
POST /api/librarygamecheckout/xxx/reset-checkout-time
The duration of the check-out time in seconds.
An explanatory note why the checkout time is being changed. This note will be added to the LibraryGame log.
Returns the same as a normal read.