Custom Wood D6

This API allows you to create custom engraved wood d6 objects. Accessible via /api/customwoodd6.

Identities

CustomWoodD6

Properties

Each custom wood d6 object is accessed via /api/customwoodd6 and has the following properties. Complete details in CustomWoodD6Properties.

id

The unique id for this custom wood d6 object. It will never change.

identity

The style of custom wood d6 object you want.

object_type

customwoodd6

date_created

A date when the custom wood d6 object was created.

date_updated

A date when the custom wood d6 object was last updated.

name

The name the custom wood d6 object is known by.

game_id

A Game id. The unique id of a game that this custom wood d6 object belongs to.

quantity

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

side1_id

A File id. Optional. Sets the side1 image of the custom wood d6 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 custom wood d6 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.

side3_id ... side6_id

Same as side1 and side2.

Related Objects

game

The Game that this custom wood d6 object is a member of.

Methods

The methods used to fetch and manipulate custom wood d6 objects.

Create

 POST /api/customwoodd6

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

See Create for details.

Delete

 DELETE /api/customwoodd6/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

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