Hook Box

Boxes that have an inside and outside. Accessible via /api/hookbox.

Identities

JumboHookBox36

PokerHookBox18

Properties

Each hook box has the following properties. Complete details in HookBoxProperties.

id

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

identity

The style of box you want.

wing_object_type

hookbox.

date_created

A date when the hook box was created.

date_updated

A date when the hook box was last updated.

name

The name the hook box is known by.

game_id

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

quantity

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

inside_id

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

has_proofed_inside

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

Related Objects

game

The Game that this hook box is a member of.

Methods

The methods used to fetch and manipulate hook boxes.

Create

 POST /api/hookbox

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

See Create for details.

Delete

 DELETE /api/hookbox/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

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