Boxes that have a face.
Accessible via /api/boxface.
Each box face has the following properties. Complete details in BoxFaceProperties.
The unique id for this box face. It will never change.
The style of box you want.
boxface.
A date when the box face was created.
A date when the box face was last updated.
The name the box face is known by.
A Game id. The unique id of a game that this box face belongs to.
An integer between 1 and 99.
Defaults to 1.
Allows for multiple copies of a box face to be included in the game.
A File id.
Sets the image that will be printed on the face part of the box.
The ID is from a File.
If a face_id is specified,
then an extra property called face will be added which will briefly describe the image.
A boolean indicating whether the face image has been verified by the user to be correct.
The methods used to fetch and manipulate box facees.
POST /api/boxface
Required. The unique session id provided by a Session method.
Required.
Required.
Optional.
Optional.
Optional.
Optional.
Optional.
Returns:
{
"id" : "xxx",
"name" : "Box",
...
}
PUT /api/boxface/xxx
See Create for details.
DELETE /api/boxface/xxx
Required. The unique session id provided by a Session method.
Returns:
{
"success" : 1
}
GET /api/boxface/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",
...
}