Score Pad

Accessible via /api/scorepad.

Identities

SmallScorePad
MediumScorePad
LargeScorePad
LargeScorePadColor
MediumScorePadColor
SmallScorePadColor

Properties

Each score pad has the following properties. Complete details in ScorePadProperties.

id

The unique id for this score pad. It will never change.

identity

The style of score pad you want.

wing_object_type

scorepad

date_created

A date when the score pad was created.

date_updated

A date when the score pad was last updated.

name

The name the score pad is known by.

game_id

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

quantity

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

image_id

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

has_proofed_image

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

page_count

Must be one of 40, 60, 80, or 100. The number of pages that will be included in this score pad.

Related Objects

game

The Game that this score pad is a member of.

Methods

The methods used to fetch and manipulate score pades.

Create

 POST /scorepad
session_id

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

name

Required.

game_id

Required.

quantity

Optional.

image_id

Optional.

page_count

Optional.

has_proofed_outside

Optional.

Returns:

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

Update

 PUT /scorepad/xxx

See Create for details.

Delete

 DELETE /scorepad/xxx
session_id

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

Returns:

 {
   "success" : 1
 }

Fetch

 GET /scorepad/xxx
session_id

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

_include_related_objects

Optional. See "Related Objects" in Intro and Related Objects above for details.

Returns:

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