Custom Printed Meeple

This API allows you to create printed meeples. Accessible via /api/customprintedmeeple.

Identities

CustomPrintedMeeple

Properties

Each printed meeple object is accessed via /api/customprintedmeeple and has the following properties. Complete details in CustomPrintedMeepleProperties.

id

The unique id for this printed meeple object. It will never change.

identity

The style of printed meeple object you want.

object_type

customprintedmeeple

date_created

A date when the printed meeple object was created.

date_updated

A date when the printed meeple object was last updated.

name

The name the printed meeple object is known by.

game_id

A Game id. The unique id of a game that this printed meeple object belongs to.

quantity

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

diecolor

The color of the dice itself before printing. Defaults to white.

side1_id

A File id. Optional. Sets the side1 image of the printed meeple 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 printed meeple 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.

Related Objects

game

The Game that this printed meeple object is a member of.

Methods

The methods used to fetch and manipulate printed meeple objects.

Create

 POST /api/customprintedmeeple

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

See Create for details.

Delete

 DELETE /api/customprintedmeeple/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

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