Boxes that only have a top.
Accessible via /api/boxtop
.
Each box top has the following properties. Complete details in BoxTopProperties.
The unique id for this box top. It will never change.
The style of box you want.
boxtop
.
A date when the box top was created.
A date when the box top was last updated.
The name the box top is known by.
A Game id. The unique id of a game that this box top belongs to.
An integer between 1 and 99.
Defaults to 1
.
Allows for multiple copies of a box top 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.
The methods used to fetch and manipulate box topes.
POST /api/boxtop
Required. The unique session id provided by a Session method.
Required.
Required.
Optional.
Optional.
Optional.
Optional.
Optional.
Returns:
{ "id" : "xxx", "name" : "Box", ... }
PUT /api/boxtop/xxx
See Create for details.
DELETE /api/boxtop/xxx
Required. The unique session id provided by a Session method.
Returns:
{ "success" : 1 }
GET /api/boxtop/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", ... }