Coil Book

All coil bound books share this API just using different identities to differentiate by size. They are all accessed via /api/coilbook.

Identities

JumboCoilBook

CoilBook Properties

Each coilbook has the following properties with complete details in CoilBookProperties:

id

The unique id for this coilbook. It will never change.

identity

The size of coilbook you want. See Identities above.

wing_object_type

coilbook

date_created

A date when the coilbook was created.

date_updated

A date when the coilbook was last updated.

name

The name the coilbook is known by.

game_id

A Game id. The unique id of a game that this coilbook belongs to.

quantity

An integer between 1 and 99. Defaults to 1. Allows for multiple copies of a coilbook to be included in the game.

page_count

The number of pages in the coilbook.

Relationships

pages

The list of CoilBookPages that are attached to this coilbook.

Related Objects

game

The Game that this coilbook is a member of.

CoilBook Methods

The methods used to fetch and manipulate coilbooks.

Create CoilBook

 POST /api/coilbook

session_id

Required. The unique session id provided by a Session method.

name

Required.

game_id

Required.

quantity

Optional.

Returns:

 {
   "id" : "xxx",
   "name" : "Rules",
   ...
 }

Update

 PUT /api/coilbook/xxx

See Create for details.

Delete

 DELETE /coilbook/xxx

session_id

Required. The unique session id provided by a Session method.

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/coilbook/xxx

session_id

Optional. The unique session id provided by a Session method.

_include_relationships

Optional. See "Relationships" in Intro and CoilBook Relationships above for details.

Returns:

 {
   "id" : "xxx",
   "name" : "Rules",
   ...
 }