Two Sided Slugged

This API allows you to access two sided slugged objects like chits, tiles, and shards. Accessible via /api/twosidedslugged.

Properties

Each two sided slugged objects is accessed via /api/twosidedslugged and has the following properties. Complete details in TwoSidedSluggedProperties.

id

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

identity

The style of two sided object you want. See Identities above for details.

object_type

twosidedslugged

date_created

A date when the two sided slugged objects was created.

date_updated

A date when the two sided slugged objects was last updated.

name

The name the two sided slugged objects is known by.

set_id

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

quantity

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

face_id

A File id. Sets the face image of the two sided slugged objects. 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 slugged objects. 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 Set that this two sided slugged objects is a member of.

Methods

The methods used to fetch and manipulate two sided slugged objects.

Create

 POST /api/twosidedslugged

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

See Create for details.

Delete

 DELETE /api/twosidedslugged/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

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