Box Top Gloss

Boxes that only have a top. Accessible via /api/boxtopgloss.

Identities

LargeStoutBoxTopAndSide

Properties

Each box top has the following properties. Complete details in BoxTopGlossProperties.

id

The unique id for this box top. It will never change.

identity

The style of box you want.

wing_object_type

boxtopgloss.

date_created

A date when the box top was created.

date_updated

A date when the box top was last updated.

name

The name the box top is known by.

game_id

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

quantity

An integer between 1 and 99. Defaults to 1. Allows for multiple copies of a box top 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.

surfacing_treatment

What type of surfacing to perform on the box. Enumerated options, use the "Options" in Intro API.

spot_gloss_id

Only used if surfacing_treatment is set to spot_gloss. A File id. Sets the image that will be printed on top of the the top art in gloss. The ID is from a File. If a spot_gloss_id is specified, then an extra property called spot_gloss will be added which will briefly describe the image.

has_proofed_spot_gloss

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

Related Objects

game

The Game that this box top is a member of.

Methods

The methods used to fetch and manipulate box topes.

Create

 POST /api/boxtopgloss

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

See Create for details.

Delete

 DELETE /api/boxtopgloss/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/boxtopgloss/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",
   ...
 }