Custom Cut One Sided Slugged

This API allows you to create sticker objects. Accessible via /api/customcutonesidedslugged.

Identities

CustomLargeSticker

CustomMediumSticker

CustomMiniSticker

CustomSmallSticker

Properties

Each custom cut one sided slugged object is accessed via /api/customcutonesidedslugged and has the following properties. Complete details in CustomCutOneSidedSluggedProperties.

id

The unique id for this custom cut one sided slugged object. It will never change.

identity

The style of custom cut one sided slugged object you want.

object_type

customcutonesidedslugged

date_created

A date when the custom cut one sided slugged object was created.

date_updated

A date when the custom cut one sided slugged object was last updated.

name

The name the custom cut one sided slugged object is known by.

game_id

A Game id. The unique id of a game that this custom cut one sided slugged object belongs to.

quantity

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

side1_id

A File id. Optional. Sets the side1 image of the custom cut one sided slugged 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.

cut_id

A File id. Sets the SVG cut file for this shape. If a cut_id is specified, then an extra property called cut will be added which will briefly describe the svg image.

Related Objects

game

The Game that this custom cut one sided slugged object is a member of.

Methods

The methods used to fetch and manipulate custom cut one sided slugged objects.

Create

 POST /api/customcutonesidedslugged

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

See Create for details.

Delete

 DELETE /api/customcutonesidedslugged/xxx

session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

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