Back to top

FiveRingsDB

An API to access cards and decks data from https://fiveringsdb.com

Cards

Resources related to cards.

Card Collection

List All Cards
GET/cards

Anonymous access.

Whenever possible, use this action and put the data into cache if you need card data. Send the If-Modified-Since request header, and use the Cache-Control and Last-Modified response headers.

Example URI

GET https://fiveringsdb.com/cards
Response  200
HideShow
Headers
Content-Type: application/json

Card

View a Card Detail
GET/cards/{code}

Anonymous access.

Get the data of one card. Don’t use this action unless you really can’t use the previous action.

Example URI

GET https://fiveringsdb.com/cards/code
URI Parameters
HideShow
code
string (required) 

ID of the Card in the form of a string slug (“a-card-code”)

Response  200
HideShow
Headers
Content-Type: application/json

Card Rulings

Resources related to cards rulings. Write access is protected by the ROLE_RULINGS permission.

Card Ruling Collection

Create a Ruling
POST/cards/{card_code}/rulings

Requires ROLE_RULINGS.

Text may be Markdown, but is not parsed.

Example URI

POST https://fiveringsdb.com/cards/card_code/rulings
URI Parameters
HideShow
card_code
string (required) 

ID of the Card in the form of a string slug (“example-card-code”)

Response  200
HideShow
Headers
Content-Type: application/json

List Rulings By Card
GET/cards/{card_code}/rulings

Anonymous access.

Text may be raw Markdown.

Example URI

GET https://fiveringsdb.com/cards/card_code/rulings
URI Parameters
HideShow
card_code
string (required) 

ID of the Card in the form of a string slug (“example-card-code”)

Response  200
HideShow
Headers
Content-Type: application/json

Card Ruling

Edit a Ruling
PATCH/cards/{card_code}/rulings/{id}

Requires ROLE_RULINGS, and user must be the ruling’s creator.

Text may be Markdown, but is not parsed.

Example URI

PATCH https://fiveringsdb.com/cards/card_code/rulings/id
URI Parameters
HideShow
card_code
string (required) 

ID of the Card in the form of a string slug (“example-card-code”)

id
integer (required) 

ID of the Ruling in the form of an integer

Response  200
HideShow
Headers
Content-Type: application/json

View a Ruling Detail
GET/cards/{card_code}/rulings/{id}

Anonymous access.

Text may be raw Markdown.

Example URI

GET https://fiveringsdb.com/cards/card_code/rulings/id
URI Parameters
HideShow
card_code
string (required) 

ID of the Card in the form of a string slug (“example-card-code”)

id
integer (required) 

ID of the Ruling in the form of an integer

Response  200
HideShow
Headers
Content-Type: application/json

Card Reviews

Resources related to cards reviews. Write access is protected by the ROLE_REVIEWS permission.

Card Review Collection

Create a Review
POST/cards/{card_code}/reviews

Requires ROLE_REVIEWS.

Text may be Markdown, but is not parsed.

Example URI

POST https://fiveringsdb.com/cards/card_code/reviews
URI Parameters
HideShow
card_code
string (required) 

ID of the Card in the form of a string slug (“example-card-code”)

Response  200
HideShow
Headers
Content-Type: application/json

List Reviews By Card
GET/cards/{card_code}/reviews

Anonymous access.

Text may be raw Markdown.

Example URI

GET https://fiveringsdb.com/cards/card_code/reviews
URI Parameters
HideShow
card_code
string (required) 

ID of the Card in the form of a string slug (“example-card-code”)

Response  200
HideShow
Headers
Content-Type: application/json

Card Review

Edit a Review
PATCH/cards/{card_code}/reviews/{id}

Requires ROLE_REVIEWS, and user must be the review’s creator.

Text may be Markdown, but is not parsed.

Example URI

PATCH https://fiveringsdb.com/cards/card_code/reviews/id
URI Parameters
HideShow
card_code
string (required) 

ID of the Card in the form of a string slug (“example-card-code”)

id
integer (required) 

ID of the Review in the form of an integer

Response  200
HideShow
Headers
Content-Type: application/json

View a Review Detail
GET/cards/{card_code}/reviews/{id}

Anonymous access.

Text may be raw Markdown.

Example URI

GET https://fiveringsdb.com/cards/card_code/reviews/id
URI Parameters
HideShow
card_code
string (required) 

ID of the Card in the form of a string slug (“example-card-code”)

id
integer (required) 

ID of the Review in the form of an integer

Response  200
HideShow
Headers
Content-Type: application/json

Generated by aglio on 12 Jul 2017