Library

Game libraries are used to track the inventory of games used at Convention, usually for free checkout. Librarys are accessed via /api/library.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in LibraryProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

geolocation

The GeoLocation that this library calls home.

user

The User that owns this library.

Relationships

See "Relationships" in Introduction for how to use them.

checkouts

The history of LibraryGameCheckouts for a game.

Qualifiers

is_checked_in

enter_in_play_to_win

win_play_to_win

conventions

Conventions that have used this library.

games

The LibraryGames contained within this library. See LibraryGame for available search options.

inventories

The LibraryInventorys associated with this library.

librarygames

The LibraryGames contained within this library. Deprecated, use games instead.

libraryinventories

The LibraryInventorys associated with this library. Deprecated, use inventories instead.

playtowins

The PlayToWins associated with this library.

Services

The services used to fetch and manipulate libraries.

Search Libraries

This will search across all libraries.

 GET /api/library

Optional Params

query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "name" : "Gulf Coast Library",
          ...
        },
        ...
    ]
 }

Create Library

 POST /api/library

Required Params

geolocation_id

name

email_address

Returns the same as a normal read.

Read Library

 GET /api/library/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "Gulf Coast Library",
   ...
 }

Update Library

 PUT /api/library/xxx

Returns the same as a normal read.

Delete Library

 DELETE /api/library/xxx

Returns:

 {
   "success" : 1
 }

Search Users

For looking up users to receive library privileges.

 GET /api/library/xxx/user

Optional Params

query

Generically search users based upon partial display names or real names, or exact matches for email addresses, if the user has set their account email to be visible to organizers.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "display_name" : "Joe User",
          ...
        },
        ...
    ]
 }

Import from Board Game Geek

This imports a game collection from a user on Board Game Geek.

 POST /api/library/xxx/import/bgg

Required Params

bgg_username

The username of the user who's collection you'd like to import into this library. Calling this service just starts the process. It will continue in the background and email the library owner when complete.

Returns:

  {
    "success" : 1
  }