API Owned Cards

See also: Full API Documentation

Objects

Name	Type	Example	Note
✅ id	Int	1
✅ owner_account	String	1	ID of the account in which this card is stored. Get the full Account object with expand_owner_account. Much slower.
✅ card	Int	530	ID of the card. Get the full Card object with expand_card. Much slower.
✅ stored	Stored choices	"Deck"
✅ idolized	Boolean	true
✅ max_level	Boolean	false
✅ max_bond	Boolean	true
expiration	Date yyyy-MM-dd'T'HH:mm:ssZZZZZ	"2015-02-15T08:00:00Z"	Expiration of cards in the present box. UTC time zone.
✅ skill	Int	8	Default: 1. Max: 8.

Choices

• stored: Deck, Album, Box, Favorite

Methods

Get the list of owned cards

GET http://schoolido.lu/api/ownedcards/

Response

Paginated array of Owned card object

Optional parameters for filtering

Name	Value	Note
owner_account	Exact value	ID of the account in which the cards are stored
card	Exact value	ID of the card
idolized	Exact value
stored	Exact value
max_level	Exact value
max_bond	Exact value
skill	Exact value	Integer 1-8
card__name	Exact value	Name of the idol in the card
card__japanese_collection	Exact value
card__rarity	Exact value	Allow multiple values separated with a comma: SR,UR
card__attribute	Exact value
card__is_promo	True or False
card__is_special	True or False
card__japan_only	True or False
card__hp	Exact value
card__skill	Exact value	skill field of the card
card__center_skill	Exact value
minimum_skill	Int
maximum_skill	Int
card__is_event	True or False

• Allowed ordering fields are: owner_account, card, idolized, stored, max_level, max_bond, skill, card__name, card__japanese_collection, card__rarity, card__attribute, card__is_promo, card__is_special, card__japan_only, card__hp, card__skill, card__center_skill
• Ordering by random is possible.
• Learn more about ordering

Optional parameters to get more data

Name	Note
expand_card	Will return the full Card object in the card field. Much slower.
expand_owner_account	Will return the full Account object in the owner_account field. Much slower.

Get an owned card by id

GET http://schoolido.lu/api/ownedcards/{id}/

Response

Owned card object

Parameters

See Get the list of owned cards.

Authenticated methods

See also: Authentication

Note regarding adding/editing owned cards

• A promo card will always be idolized
• A special card will never be idolized
• Non idolized cards will never be max bonded or max leveled
• Cards in album will always have a skill level 1

The owned card objects will always respect these rules. Attempting to change one of these behaviors will not work, but you will not receive an error. Therefore, it's recommended to update your full objects when you receive a response (and not just what you edited) to make sure it really corresponds to what's in database.

Add an owned card

POST http://schoolido.lu/api/ownedcards/

Response

Owned card object

POST parameters

Name	Value	Note	Default value
owner_account	Exact value	id of the account	Required
card	Exact value	id of the card	Required
stored	Exact value	Stored choices	"Deck"
idolized	True or False		"False"
max_level	True or False		"False"
max_bond	True or False		"False"
skill	Exact value	Skill level between 1 and 8	1
expiration	Exact value	Date time when a card in the present box expires	null

Edit an owned card

PATCH http://schoolido.lu/api/ownedcards/{owned card id}/

Response

Owned card object

POST parameters

Name	Value	Note
stored	Exact value	Stored choices
idolized	True or False
max_level	True or False
max_bond	True or False
skill	Exact value	Skill level between 1 and 8
expiration	Exact value	Date time when a card in the present box expires

Delete an owned card

DELETE http://schoolido.lu/api/ownedcards/{owned card id}/

Response

204 NO CONTENT with an empty body.

Parameters

No parameter.