Booklet

All saddle-stitched booklets share this API just using different identities to differentiate by size. They are all accessed via /api/booklet.

Identities

SmallBooklet
TarotBooklet
LargeBooklet
MediumBooklet
JumboBooklet
TallBooklet

Properties

Each booklet has the following properties with complete details in BookletProperties:

id

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

identity

The size of booklet you want. See Identities above.

wing_object_type

booklet

date_created

A date when the booklet was created.

date_updated

A date when the booklet was last updated.

name

The name the booklet is known by.

game_id

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

quantity

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

page_count

The number of pages in the booklet.

Relationships

pages

The list of BookletPages that are attached to this booklet.

Related Objects

game

The Game that this booklet is a member of.

Methods

The methods used to fetch and manipulate booklets.

Create

 POST /api/booklet
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/booklet/xxx

See Create for details.

Delete

 DELETE /booklet/xxx
session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/booklet/xxx
session_id

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

_include_relationships

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

Returns:

 {
   "id" : "xxx",
   "name" : "Rules",
   ...
 }
^ Back to Top ^