One Sided

This API allows you to create one-sided items like neoprene mats. Accessible via "api/onesided"

Identities

BiFoldBoard

MediumGameMat

SmallGameMat

VHSBox

Properties

Complete details in OneSidedProperties.

id

The unique id. It will never change.

identity

See Identities above for details.

wing_object_type

onesided

date_created

A date when was created.

date_updated

A date when was last updated.

name

The name is known by.

game_id

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

quantity

An integer between 1 and 99. Defaults to 1. Allows for multiple copies to be included in the game.

face_id

A File id. The id of the image attached to the face side. 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.

Related Objects

game

The Game that this is a member of.

Methods

The methods used to fetch and manipulate.

Create

 POST /api/onesided

session_id

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

name

Required.

game_id

Required.

quantity

Optional.

face_id

Optional.

has_proofed_face

Returns:

 {
   "id" : "xxx",
   "name" : "Cell Block",
   ...
 }

Update

 PUT /api/onesided/xxx

See Create for details.

Delete

 DELETE /api/onesided/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/onesided/xxx

session_id

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

_include_relationships

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

Returns:

 {
   "id" : "xxx",
   "name" : "Cell Block",
   ...
 }