The child element of Decks are cards which are accessible via /api/card
.
Each card has the following properties. Complete details in CardProperties.
The unique id for this card. It will never change.
pokercard
A date when the card was created.
A date when the card was last updated.
The name the card is known by.
A Deck id. The unique id of a deck that this card belongs to.
An integer between 1 and 99.
Defaults to 1
.
Allows for multiple copies of a card to be included in the deck.
Defaults to Deck
.
Allows the card to inherit a back from the deck,
or set to Card
to use one from the card itself.
See Card Options below for details.
A File id.
Sets the face image of the card.
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.
A File id.
Sets the face image of the card.
The ID is from a File.
Not needed if back_from
= Deck
.
If a back_id is specified,
then an extra property called back
will be added which will briefly describe the image.
A boolean indicating whether the face image has been verified by the user to be correct.
A boolean indicating whether the back image has been verified by the user to be correct.
The methods used to fetch and manipulate cards.
Provides a list of the options that can be used to fill out various fields when creating or updating a card.
GET /api/card/_options
Returns:
{ "back_from" : [...] }
NOTE: You can also get this data by adding _include_options=1
to the parameter list when fetching a card.
POST /api/card
Required. The unique session id provided by a Session method.
Required.
Required.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Returns:
{ "id" : "xxx", "name" : "Rope", ... }
PUT /api/card/xxx
See Card for details.
DELETE /api/card/xxx
Required. The unique session id provided by a Session method.
Returns:
{ "success" : 1 }
GET /api/card/xxx
Optional. The unique session id provided by a Session method.
Optional. See "Options" in Intro and Card Options above for details.
Optional. See "Relationships" in Intro and Card Relationships above for details.
Returns:
{ "id" : "xxx", "name" : "Rope", ... }