Acrylic Shape

This API allows you to create custom acrylic shape objects like meeples and tokens. Accessible via /api/acrylicshape.

Identities

AcrylicShape125

AcrylicShape250

LargeAcrylicShape125

Properties

Each acrylic shape object is accessed via /api/acrylicshape and has the following properties. Complete details in AcrylicShapeProperties.

id

The unique id for this acrylic shape object. It will never change.

identity

The style of acrylic shape object you want.

object_type

acrylicshape

date_created

A date when the acrylic shape object was created.

date_updated

A date when the acrylic shape object was last updated.

name

The name the acrylic shape object is known by.

game_id

A Game id. The unique id of a game that this acrylic shape object belongs to.

quantity

An integer between 1 and 99. Defaults to 1. Allows for multiple copies of a acrylic shape object to be included in the game.

side1_id

A File id. Optional. Sets the side1 image of the acrylic shape object. The ID is from a File. If a side1_id is specified, then an extra property called side1 will be added which will briefly describe the image.

has_proofed_side1

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

side2_id

A File id. Optional. Sets the side2 image of the acrylic shape object. The ID is from a File. If a side2_id is specified, then an extra property called side2 will be added which will briefly describe the image.

has_proofed_side2

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

cut_id

A File id. Sets the SVG cut file for this shape. If a cut_id is specified, then an extra property called cut will be added which will briefly describe the svg image.

Related Objects

game

The Game that this acrylic shape object is a member of.

Methods

The methods used to fetch and manipulate acrylic shape objects.

Create

 POST /api/acrylicshape

session_id

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

name

Required.

game_id

Required.

quantity

Optional.

side1_id

Optional.

has_proofed_side1

Optional.

Returns:

 {
   "id" : "xxx",
   "name" : "Guard",
   ...
 }

Update

 PUT /api/acrylicshape/xxx

See Create for details.

Delete

 DELETE /api/acrylicshape/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/acrylicshape/xxx

session_id

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

_include_relationships

Optional. See "Related Objects" in Intro and Related Objects above for details.

Returns:

 {
   "id" : "xxx",
   "name" : "Guard",
   ...
 }