API documentation

body format: request format:

    • Card
    • Collection
    • Deck
    • Decklist
    • Faction
    • Faq
    • Pack
    • Taboo
  • Show/hide List Operations Expand Operations

    Card

    • /api/public/card/{card_code}

        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/card/{card_code}.{_format}

          • One Card
          • Documentation
          • Sandbox

          Documentation

          Get the description of a card as a JSON object.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/public/cards/

        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/

          • Returns all the cards. Defaults to player cards only. Set the encounter parameter to 1 if you want encounter cards included.
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the cards as an array of JSON objects.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          encounter integer false Set this to 1 to also get encounter cards
          Input

          Parameters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/public/cards/{pack_code}

        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/public/cards/{pack_code}.{_format}

          • All the Cards from One Pack
          • Documentation
          • Sandbox

          Documentation

          Get the description of all the card from a pack, as an array of JSON objects.

          Requirements

          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.

          Parameters

          Parameter Type Required? Format Description
          jsonp string false JSONP callback
          Input

          Requirements

          = -

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
  • Show/hide List Operations Expand Operations

    Collection

    • /api/oauth2/collection

        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/collection

          • Update the list of Collections
          • Documentation
          • Sandbox

          Documentation

          Update the list of Collections of the authenticated user

          Parameters

          Parameter Type Required? Format Description
          collection string true JSON Comma separated list of collection pack ids
          Input

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
  • Show/hide List Operations Expand Operations

    Deck

    • /api/oauth2/deck/delete/{id}

        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • DELETE /api/oauth2/deck/delete/{id}

          • Delete One Deck
          • Documentation
          • Sandbox

          Documentation

          Delete the latest or all versions of a Deck of the authenticated user.

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to delete.

          Parameters

          Parameter Type Required? Format Description
          all boolean false Delete all versions of deck.
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/oauth2/deck/load/{id}

        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/oauth2/deck/load/{id}

          • Load One Deck
          • Documentation
          • Sandbox

          Documentation

          Get the description of one Deck of the authenticated user

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to load
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/oauth2/deck/new

        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/oauth2/deck/new

          • Create a New Deck
          • Documentation
          • Sandbox

          Documentation

          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.

          Parameters

          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
          Input

          Parameters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/oauth2/deck/publish/{id}

        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/oauth2/deck/publish/{id}

          • Publish One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to publish

          Parameters

          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
          Input

          Requirements

          = -

          Parameters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/oauth2/deck/save/{id}

        • PUT /api/oauth2/deck/save/{id}

          • Save One Deck
          • Documentation
          • Sandbox

          Documentation

          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

          Requirements

          Name Requirement Type Description
          id \d+ integer The numeric identifier of the Deck to update.

          Parameters

          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