Boxes that have a top and a bottom.
Accessible via /api/twosidedbox
.
Each two sided box has the following properties. Complete details in TwoSidedBoxProperties.
The unique id for this two sided box. It will never change.
The style of box you want.
twosidedbox
.
A date when the two sided box was created.
A date when the two sided box was last updated.
The name the two sided box is known by.
A Game id. The unique id of a game that this two sided box belongs to.
An integer between 1 and 99.
Defaults to 1
.
Allows for multiple copies of a two sided box to be included in the game.
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.
A boolean indicating whether the top image has been verified by the user to be correct.
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.
A boolean indicating whether the bottom image has been verified by the user to be correct.
The methods used to fetch and manipulate two sided boxes.
POST /api/twosidedbox
Required. The unique session id provided by a Session method.
Required.
Required.
Optional.
Optional.
Optional.
Optional.
Optional.
Returns:
{ "id" : "xxx", "name" : "Box", ... }
PUT /api/twosidedbox/xxx
See Create for details.
DELETE /api/twosidedbox/xxx
Required. The unique session id provided by a Session method.
Returns:
{ "success" : 1 }
GET /api/twosidedbox/xxx
Optional. The unique session id provided by a Session method.
Optional. See "Related Objects" in Intro and Related Objects above for details.
Returns:
{ "id" : "xxx", "name" : "Box", ... }