Two Sided

This API allows you to create two sided objects like mats and boards. Accessible via /api/twosided.

Properties

Each two sided object is accessed via /api/twosided and has the following properties. Complete details in TwoSidedProperties.

id

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

object_type

twosided

date_created

A date when the two sided object was created.

date_updated

A date when the two sided object was last updated.

name

The name the two sided object is known by.

set_id

A TwoSidedSet id. The unique id of a two sided set that this two sided object belongs to.

quantity

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

face_id

A File id. Sets the face image of the two sided object. 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.

has_proofed_face

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

back_id

A File id. Sets the back image of the two sided object. 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.

back_from

A boolean indicating whether the back image should be taken from the set, or from this object.

Related Objects

set

The TwoSidedSet that this two sided object is a member of.

Methods

The methods used to fetch and manipulate two sided objects.

Create

 POST /api/twosided

session_id

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

name

Required.

set_id

Required.

quantity

Optional.

face_id

Optional.

has_proofed_face

Optional.

Returns:

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

Update

 PUT /api/twosided/xxx

See Create for details.

Delete

 DELETE /api/twosided/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/twosided/xxx

session_id

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

_include_relationships

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

Returns:

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