Get the description of a card as a JSON object.
| Name | Requirement | Type | Description |
|---|---|---|---|
| card_code | string | The code of the card to get, e.g. '01001' | |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of a card as a JSON object.
| Name | Requirement | Type | Description |
|---|---|---|---|
| card_code | string | The code of the card to get, e.g. '01001' | |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of a card as a JSON object.
| Name | Requirement | Type | Description |
|---|---|---|---|
| card_code | string | The code of the card to get, e.g. '01001' | |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of all the cards as an array of JSON objects.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback | |
| encounter | integer | false | Set this to 1 to also get encounter cards |
Get the description of all the cards as an array of JSON objects.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback | |
| encounter | integer | false | Set this to 1 to also get encounter cards |
Get the description of all the cards as an array of JSON objects.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback | |
| encounter | integer | false | Set this to 1 to also get encounter cards |
Get the description of all the card from a pack, as an array of JSON objects.
| Name | Requirement | Type | Description |
|---|---|---|---|
| pack_code | string | The code of the pack to get the cards from, e.g. 'Core' | |
| _format | json|xml|xlsx|xls | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of all the card from a pack, as an array of JSON objects.
| Name | Requirement | Type | Description |
|---|---|---|---|
| pack_code | string | The code of the pack to get the cards from, e.g. 'Core' | |
| _format | json|xml|xlsx|xls | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of all the card from a pack, as an array of JSON objects.
| Name | Requirement | Type | Description |
|---|---|---|---|
| pack_code | string | The code of the pack to get the cards from, e.g. 'Core' | |
| _format | json|xml|xlsx|xls | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Delete the latest or all versions of a Deck of the authenticated user.
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to delete. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| all | boolean | false | Delete all versions of deck. |
Delete the latest or all versions of a Deck of the authenticated user.
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to delete. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| all | boolean | false | Delete all versions of deck. |
Delete the latest or all versions of a Deck of the authenticated user.
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to delete. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| all | boolean | false | Delete all versions of deck. |
Create a new deck for the authenticated user. An investigator is required, and the deck will be created empty with only the 'required' cards for that investigator. If successful, id of new Deck is in the msg.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| investigator | string | true | Code of the investigator card. | |
| name | string | false | Name of the Deck. A default name will be generated if it is not specified. | |
| taboo | integer | false | Taboo set that this deck conforms to. | |
| meta | string | false | JSON formatted meta data |
Create a new deck for the authenticated user. An investigator is required, and the deck will be created empty with only the 'required' cards for that investigator. If successful, id of new Deck is in the msg.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| investigator | string | true | Code of the investigator card. | |
| name | string | false | Name of the Deck. A default name will be generated if it is not specified. | |
| taboo | integer | false | Taboo set that this deck conforms to. | |
| meta | string | false | JSON formatted meta data |
Create a new deck for the authenticated user. An investigator is required, and the deck will be created empty with only the 'required' cards for that investigator. If successful, id of new Deck is in the msg.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| investigator | string | true | Code of the investigator card. | |
| name | string | false | Name of the Deck. A default name will be generated if it is not specified. | |
| taboo | integer | false | Taboo set that this deck conforms to. | |
| meta | string | false | JSON formatted meta data |
Try to publish one Deck of the authenticated user If publication is successful, update the version of the deck and return the id of the decklist
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to publish |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| description_md | string | false | Description of the Decklist in Markdown | |
| tournament_id | integer | false | Identifier of the Tournament type of the Decklist | |
| precedent_id | integer | false | Identifier of the Predecessor of the Decklist |
Try to publish one Deck of the authenticated user If publication is successful, update the version of the deck and return the id of the decklist
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to publish |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| description_md | string | false | Description of the Decklist in Markdown | |
| tournament_id | integer | false | Identifier of the Tournament type of the Decklist | |
| precedent_id | integer | false | Identifier of the Predecessor of the Decklist |
Try to publish one Deck of the authenticated user If publication is successful, update the version of the deck and return the id of the decklist
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to publish |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| description_md | string | false | Description of the Decklist in Markdown | |
| tournament_id | integer | false | Identifier of the Tournament type of the Decklist | |
| precedent_id | integer | false | Identifier of the Predecessor of the Decklist |
Save one Deck of the authenticated user. The parameters are the same as in the response to the load method, but only a few are writable. So you can parse the result from the load, change a few values, then send the object as the param of an ajax request. If successful, id of Deck is in the msg
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to update. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | false | Name of the Deck if a change is needed. | |
| decklist_id | integer | false | Identifier of the Decklist from which the Deck is copied | |
| description_md | string | false | Description of the Decklist in Markdown | |
| tags | string | false | Space-separated list of tags | |
| slots | string | true | Content of the Decklist as a JSON object | |
| problem | string | true | A short code description of the problem with the provided slots, if one exists. Must be one of: too_few_cards,too_many_cards,too_many_copies,invalid_cards,deck_options_limit,investigator | |
| taboo | integer | false | Taboo set this deck conforms to | |
| meta | string | false | JSON formatted meta data |
Save one Deck of the authenticated user. The parameters are the same as in the response to the load method, but only a few are writable. So you can parse the result from the load, change a few values, then send the object as the param of an ajax request. If successful, id of Deck is in the msg
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to update. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | false | Name of the Deck if a change is needed. | |
| decklist_id | integer | false | Identifier of the Decklist from which the Deck is copied | |
| description_md | string | false | Description of the Decklist in Markdown | |
| tags | string | false | Space-separated list of tags | |
| slots | string | true | Content of the Decklist as a JSON object | |
| problem | string | true | A short code description of the problem with the provided slots, if one exists. Must be one of: too_few_cards,too_many_cards,too_many_copies,invalid_cards,deck_options_limit,investigator | |
| taboo | integer | false | Taboo set this deck conforms to | |
| meta | string | false | JSON formatted meta data |
Save one Deck of the authenticated user. The parameters are the same as in the response to the load method, but only a few are writable. So you can parse the result from the load, change a few values, then send the object as the param of an ajax request. If successful, id of Deck is in the msg
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to update. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | false | Name of the Deck if a change is needed. | |
| decklist_id | integer | false | Identifier of the Decklist from which the Deck is copied | |
| description_md | string | false | Description of the Decklist in Markdown | |
| tags | string | false | Space-separated list of tags | |
| slots | string | true | Content of the Decklist as a JSON object | |
| problem | string | true | A short code description of the problem with the provided slots, if one exists. Must be one of: too_few_cards,too_many_cards,too_many_copies,invalid_cards,deck_options_limit,investigator | |
| taboo | integer | false | Taboo set this deck conforms to | |
| meta | string | false | JSON formatted meta data |
Upgrade a deck of the authenticated user. Takes a parameter for the amount of XP earned + a list of exiled cards. This also serves to lock changes so that future card swaps are properly accounted for in the campaign XP. If successful, the id of the new Deck is in the msg.
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to update. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| xp | integer | true | Number of XP earned to apply to the upgrade | |
| exiles | string | false | Optional comma separated list of card codes to 'exile'. All passed codes must be present in the existing deck and must be exilable cards. | |
| meta | string | false | JSON formatted meta data |
Upgrade a deck of the authenticated user. Takes a parameter for the amount of XP earned + a list of exiled cards. This also serves to lock changes so that future card swaps are properly accounted for in the campaign XP. If successful, the id of the new Deck is in the msg.
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to update. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| xp | integer | true | Number of XP earned to apply to the upgrade | |
| exiles | string | false | Optional comma separated list of card codes to 'exile'. All passed codes must be present in the existing deck and must be exilable cards. | |
| meta | string | false | JSON formatted meta data |
Upgrade a deck of the authenticated user. Takes a parameter for the amount of XP earned + a list of exiled cards. This also serves to lock changes so that future card swaps are properly accounted for in the campaign XP. If successful, the id of the new Deck is in the msg.
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ | integer | The numeric identifier of the Deck to update. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| xp | integer | true | Number of XP earned to apply to the upgrade | |
| exiles | string | false | Optional comma separated list of card codes to 'exile'. All passed codes must be present in the existing deck and must be exilable cards. | |
| meta | string | false | JSON formatted meta data |
Get the description of one public Deck
| Name | Requirement | Type | Description |
|---|---|---|---|
| deck_id | \d+ | integer | The numeric identifier of the deck |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of one public Deck
| Name | Requirement | Type | Description |
|---|---|---|---|
| deck_id | \d+ | integer | The numeric identifier of the deck |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of one public Deck
| Name | Requirement | Type | Description |
|---|---|---|---|
| deck_id | \d+ | integer | The numeric identifier of the deck |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of a decklist as a JSON object.
| Name | Requirement | Type | Description |
|---|---|---|---|
| decklist_id | \d+ | integer | The numeric identifier of the decklist |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of a decklist as a JSON object.
| Name | Requirement | Type | Description |
|---|---|---|---|
| decklist_id | \d+ | integer | The numeric identifier of the decklist |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of a decklist as a JSON object.
| Name | Requirement | Type | Description |
|---|---|---|---|
| decklist_id | \d+ | integer | The numeric identifier of the decklist |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of all the decklists published at a given date, as an array of JSON objects.
| Name | Requirement | Type | Description |
|---|---|---|---|
| date | \d\d\d\d-\d\d-\d\d | string | The date, format 'Y-m-d' |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of all the decklists published at a given date, as an array of JSON objects.
| Name | Requirement | Type | Description |
|---|---|---|---|
| date | \d\d\d\d-\d\d-\d\d | string | The date, format 'Y-m-d' |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the description of all the decklists published at a given date, as an array of JSON objects.
| Name | Requirement | Type | Description |
|---|---|---|---|
| date | \d\d\d\d-\d\d-\d\d | string | The date, format 'Y-m-d' |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the faq entry for a given card
| Name | Requirement | Type | Description |
|---|---|---|---|
| card_code | string | The code of the card to get the faq for, e.g. '01001' | |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the faq entry for a given card
| Name | Requirement | Type | Description |
|---|---|---|---|
| card_code | string | The code of the card to get the faq for, e.g. '01001' | |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Get the faq entry for a given card
| Name | Requirement | Type | Description |
|---|---|---|---|
| card_code | string | The code of the card to get the faq for, e.g. '01001' | |
| _format | json | string | The format of the returned data. Only 'json' is supported at the moment. |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| jsonp | string | false | JSONP callback |
Documentation auto-generated on Fri, 14 Aug 26 04:08:55 +0000