Three Sided Custom Cut Set

This API allows you to create sets of two sided sets like mats and boards. Accessible via /api/threesidedcustomcutset.

Identities

SmallDualLayerBoardSet

MediumDualLayerBoardSet

LargeDualLayerBoardSet

Properties

Each three sided set is accessed via /api/threesidedcustomcutset and has the following properties. Complete details in TwoSidedSluggedSetProperties.

id

The unique id for this two sided set. It will never change.

identity

The style of two sided set you want.

object_type

threesidedcustomcutset

date_created

A date when the two sided set was created.

date_updated

A date when the two sided set was last updated.

name

The name the two sided set is known by.

game_id

A Game id. The unique id of a game that this three sided custom cut set belongs to.

quantity

An integer between 1 and 99. Defaults to 1. Allows for multiple copies of a two sided set to be included in the game.

back_id

A File id. Sets the back image of the two sided set. The ID is from a File. If a back_id is specified, then an extra property called back will be added which will briefly describe the image.

has_proofed_back

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

Related Objects

game

The Game that this two sided set is a member of.

Relationships

members

The ThreeSidedCustomCut members that belong to this set.

Methods

The methods used to fetch and manipulate two sided sets.

Create

 POST /api/threesidedcustomcutset

session_id

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

name

Required.

game_id

Required.

quantity

Optional.

back_id

Optional.

has_proofed_back

Optional.

Returns:

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

Update

 PUT /api/threesidedcustomcutset/xxx

See Create for details.

Delete

 DELETE /api/threesidedcustomcutset/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/threesidedcustomcutset/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.

_include_relationships

Optional. See "Relationships" in Intro and Relationships above for details.

Returns:

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