Disciplines

GET /disciplines

Simple Access

Returns a collection of disciplines.

Resource URL

https://api.toornament.com/organizer/v2/disciplines

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Range
    string

    A range of requested items using the discipline unit. The size of the range can not exceed 50. (see Pagination)

    Example: discipline=0-49

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[206] Disciplines retrieved.

Example
[
    {
        "id": "counterstrike_go",
        "name": "Counter-Strike: GO",
        "shortname": "CS:GO",
        "fullname": "Counter-Strike: Global Offensive",
        "copyrights": "Valve Software"
    }
]
Structure (collection)
  • id
    string

    An identifier for a discipline, can be used in others APIs.

    Example: "counterstrike_go"

  • name
    string

    The official name of the discipline.

    Example: "Counter-Strike: GO"

  • shortname
    string

    The short name of the discipline.

    Example: "CS:GO"

  • fullname
    string

    The complete name of the discipline.

    Example: "Counter-Strike: Global Offensive"

  • copyrights
    string

    Name of the entity or entities that are the creators and/or right holders of the discipline.

    Example: "Valve Software"

GET /disciplines/{id}

Simple Access

Returns a discipline with its information and configuration options.

Resource URL

https://api.toornament.com/organizer/v2/disciplines/{id}

HTTP headers

Path parameters

  • id
    string

    The id of the discipline.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Discipline retrieved.

Example
{
    "id": "counterstrike_go",
    "name": "Counter-Strike: GO",
    "shortname": "CS:GO",
    "fullname": "Counter-Strike: Global Offensive",
    "copyrights": "Valve Software",
    "platforms_available": [
        "pc",
        "nintendo_switch",
        "neo_geo"
    ],
    "team_size": {
        "min": 4,
        "max": 4
    },
    "features": [
        {
            "name": "track",
            "type": "map",
            "options": {}
        }
    ]
}
Structure (object)
  • id
    string

    An identifier for a discipline, can be used in others APIs.

    Example: "counterstrike_go"

  • name
    string

    The official name of the discipline.

    Example: "Counter-Strike: GO"

  • shortname
    string

    The short name of the discipline.

    Example: "CS:GO"

  • fullname
    string

    The complete name of the discipline.

    Example: "Counter-Strike: Global Offensive"

  • copyrights
    string

    Name of the entity or entities that are the creators and/or right holders of the discipline.

    Example: "Valve Software"

  • platforms_available
    array[string]

    A list of platforms available of this discipline.

    Possible values: pc, playstation4, xbox_one, nintendo_switch, mobile, playstation3, playstation2, playstation1, ps_vita, psp, xbox360, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, dreamcast, saturn, megadrive, master_system, 3ds, ds, game_boy, neo_geo, other_platform, not_video_game

  • team_size
    object

    Sets the minimum and maximum of players in a team.

  • features
    array[object]

    List of features for the discipline.