Tuck Box

Accessible via /tuckbox.

Identities

Each tuck box has the following properties. Complete details in TuckBoxProperties.

id: The unique id for this tuck box. It will never change.
identity: The style of tuck box you want. See Identities above for details.
wing_object_type: tuckbox
date_created: A date when the tuck box was created.
date_updated: A date when the tuck box was last updated.
name: The name the tuck box is known by.
game_id: A Game id. The unique id of a game that this tuck box belongs to.
quantity: An integer between 1 and 99. Defaults to 1. Allows for multiple copies of a tuck box to be included in the game.
outside_id: A File id. Sets the image that will be printed on the outside of the box. The ID is from a File. If a outside_id is specified, then an extra property called outside will be added which will briefly describe the image.
has_proofed_outside: A boolean indicating whether the outside image has been verified by the user to be correct.

The methods used to fetch and manipulate tuck boxes.

 POST /tuckbox

Returns:

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

 PUT /tuckbox/xxx

See Create Tuck Box for details.

 DELETE /tuckbox/xxx

Returns:

 {
   "success" : 1
 }

 GET /tuckbox/xxx

session_id: Optional. The unique session id provided by a Session method.
_include_relationships: Optional. See "Relationships" in Intro and Tuck Box Relationships above for details.

Returns:

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

Developer Documentation