Kanka logo Kanka

Races


All Races

You can get a list of all the races of a campaign by using the following endpoint.

{warning} Don't forget that all endpoints documented here need to be prefixed with api/1.0/campaigns/{campaign.id}/.

Method Endpoint Headers
GET/HEAD races Default

Results

{
    "data": [
        {
            "id": 1,
            "name": "Goblin",
            "entry": "\n<p>Lorem Ipsum.</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "is_private": true,
            "entity_id": 7,
            "tags": [],
            "created_at": {
                "date": "2017-10-31 10:55:08.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_by": 1,
            "updated_at": {
                "date": "2018-09-20 09:18:58.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_by": 1,
            "race_id": 3,
            "type": null
        }
    ]
}

Race

To get the details of a single race, use the following endpoint.

Method Endpoint Headers
GET/HEAD races/{race.id} Default

Results

{
    "data": {
        "id": 1,
        "name": "Goblin",
        "entry": "\n<p>Lorem Ipsum.</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "is_private": true,
        "entity_id": 7,
        "tags": [],
        "created_at": {
            "date": "2017-10-31 10:55:08.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "created_by": 1,
        "updated_at": {
            "date": "2018-09-20 09:18:58.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_by": 1,
        "race_id": 3,
        "type": null
    }

}

Create a Race

To create a race, use the following endpoint.

Method Endpoint Headers
POST races Default

Body

Parameter Type Detail
name string (Required) Name of the race
type string The race's type
race_id string Parent race of the race
tags array Array of tag ids
is_private boolean If the race is only visible to admin members of the campaign
image stream Stream to file uploaded to the race
image_url string URL to a picture to be used for the race

Results

{success} Code 200 with JSON body of the new race.

Update a Race

To update a race, use the following endpoint.

Method Endpoint Headers
PUT/PATCH races/{race.id} Default

Body

The same body parameters are available as for when creating a race.

Results

{success} Code 200 with JSON body of the updated race.

Delete a Race

To delete a race, use the following endpoint.

Method Endpoint Headers
DELETE races/{race.id} Default

Results

{success} Code 200 with JSON.