Perfect Bound Book

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

Identities

DigestPerfectBoundBook

LetterPerfectBoundBook

Properties

Each perfect bound book has the following properties with complete details in PerfectBoundBookProperties:

id

The unique id for this perfect bound book. It will never change.

identity

The size of perfect bound book you want. See Identities above.

wing_object_type

perfectboundbook

date_created

A date when the perfect bound book was created.

date_updated

A date when the perfect bound book was last updated.

name

The name the perfect bound book is known by.

game_id

A Game id. The unique id of a game that this perfect bound book belongs to.

quantity

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

page_count

The number of pages in the perfect bound book.

spine_image_id

A File id. The image to be printed on the spine of the book.

has_proofed_spine

A boolean indicating whether the user has looked at the spine image and approved it.

Relationships

pages

The list of PerfectBoundBookPages that are attached to this perfect bound book.

Related Objects

game

The Game that this perfect bound book is a member of.

Methods

The methods used to fetch and manipulate perfect bound book.

Create

 POST /api/perfectboundbook

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/perfectboundbook/xxx

See Create for details.

Delete

 DELETE /perfectboundbook/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/perfectboundbook/xxx

session_id

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

_include_relationships

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

Returns:

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