Dial Types

Dials are accessed via /api/dial.

Identities

SmallDial
DualDial

Dial Properties

Each dial has the following properties. Complete details in DialProperties.

id

The unique id for this dial. It will never change.

identity

The style of dial you want. See Identities above.

wing_object_type

smalldial

date_created

A date when the dial was created.

date_updated

A date when the dial was last updated.

name

The name the dial is known by.

game_id

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

quantity

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

outside_id

A File id. Sets the image that will be printed on the outside of the dial. The ID is from a File. If a outside_id is specified, then an extra property called outside will be added which will briefly describe the image.

has_proofed_outside

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

Related Objects

game

The Game that this dial is a member of.

Dial Methods

The methods used to fetch and manipulate diales.

Create Dial

 POST /api/dial
session_id

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

name

Required.

game_id

Required.

quantity

Optional.

outside_id

Optional.

has_proofed_outside

Optional.

Returns:

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

Update Dial

 PUT /api/dial/xxx

See Create Dial for details.

Delete Dial

 DELETE /api/dial/xxx
session_id

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

Returns:

 {
   "success" : 1
 }

Fetch Dial

 GET /api/dial/xxx
session_id

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

_include_relationships

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

Returns:

 {
   "id" : "xxx",
   "name" : "Dial",
   ...
 }
^ Back to Top ^