Two Sided Box

Boxes that have a top and a bottom. Accessible via /api/twosidedbox.

Identities

DeckBox
LargeRetailBox
MediumProBox
MediumStoutBox
MintTin
SmallProBox
SmallStoutBox

Properties

Each two sided box has the following properties. Complete details in TwoSidedBoxProperties.

id

The unique id for this two sided box. It will never change.

identity

The style of box you want.

wing_object_type

twosidedbox.

date_created

A date when the two sided box was created.

date_updated

A date when the two sided box was last updated.

name

The name the two sided box is known by.

game_id

A Game id. The unique id of a game that this two sided box belongs to.

quantity

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

top_id

A File id. Sets the image that will be printed on the top part of the box. The ID is from a File. If a top_id is specified, then an extra property called top will be added which will briefly describe the image.

has_proofed_top

A boolean indicating whether the top image has been verified by the user to be correct.

bottom_id

A File id. Sets the image that will be printed on the bottom part of the box. The ID is from a File. If a bottom_id is specified, then an extra property called bottom will be added which will briefly describe the image.

has_proofed_bottom

A boolean indicating whether the bottom image has been verified by the user to be correct.

Related Objects

game

The Game that this two sided box is a member of.

Methods

The methods used to fetch and manipulate two sided boxes.

Create

 POST /api/twosidedbox
session_id

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

name

Required.

game_id

Required.

quantity

Optional.

top_id

Optional.

has_proofed_top

Optional.

bottom_id

Optional.

has_proofed_bottom

Optional.

Returns:

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

Update

 PUT /api/twosidedbox/xxx

See Create for details.

Delete

 DELETE /api/twosidedbox/xxx
session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/twosidedbox/xxx
session_id

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

_include_related_objects

Optional. See "Related Objects" in Intro and Related Objects above for details.

Returns:

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