Data Models
This page describes the data models used by the Trading Card API.
Card
A trading card resource following JSON:API specification
Properties
| Property | Type | Description |
|---|---|---|
| type | string | Resource type |
| id | string | Unique identifier |
| attributes | object | |
| relationships | object |
Set
A trading card set resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object | |
| relationships | object | Related resources. The genre, manufacturer, brand, and year relationships replace the previously flat FK attributes and are only populated when explicitly requested via ?include=genre,manufacturer,brand,year. |
Player
A player resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
Team
A team resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
PaginationLinks
JSON:API pagination links
Properties
| Property | Type | Description |
|---|---|---|
| first | string | |
| last | string | |
| prev | string | |
| next | string |
PaginationMeta
JSON:API pagination metadata
Properties
| Property | Type | Description |
|---|---|---|
| current_page | integer | |
| from | integer | |
| to | integer | |
| per_page | integer | |
| total | integer | |
| last_page | integer |
ErrorResponse
JSON:API error response format
Properties
| Property | Type | Description |
|---|---|---|
| errors | array |
Attribute
An attribute definition resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
Brand
A brand resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
Manufacturer
A manufacturer resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
Year
A year resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
Genre
A genre resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
ObjectAttribute
An object attribute instance resource linking an attribute to a specific object
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
PlayerTeam
A player-team relationship resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
SetSource
A set source tracking resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
SetTodo
A workflow step todo resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | string | |
| attributes | object |
AuditLog
An audit log event resource
Properties
| Property | Type | Description |
|---|---|---|
| type | string | |
| id | integer | |
| attributes | object |