Manage Categories

This section describes how you can add and remove categories from charts through the API.

Note

Seats.io creates a draft chart version when you update a chart's categories. If a draft version already exists, that draft gets updated.
This does not apply to charts without events. For those charts we don't create a draft version.

Adding a category

Text

curl https://api-{region}.seatsio.net/charts/{chartKey}/categories \
-u aSecretKey: -X POST -H 'Content-Type: application/json' -d '{"key": "1"}'

PHP

$categoryToAdd = (new CategoryRequestBuilder())->setKey(1)->setLabel('Category 1')->setColor('#aaaaaa');
$seatsioClient->charts->addCategory($chartKey, $categoryToAdd);

C#

var Key = 1;
var Label = "category 1"
var Color = "#aaaaaa"; 
var Accessible = false;
await Client.Charts.AddCategoryAsync(chart.Key, new Category(Key, Label, Color, Accessible));

Java

Category categoryToAdd = new Category(CategoryKey.of(1L), "Category 1", "#aaaaaa", true);
client.charts.addCategory(chart.key,  categoryToAdd);

Python

category_to_add = {"key": 2, "label": "Category 2", "color": "#bbbbbb", "accessible": True}
client.charts.add_category(chart.key, category_to_add)

Ruby

category_to_add = { 'key' => 'cat2', 'label' => 'Category 2', 'color' => '#bbbbbb', 'accessible' => true }
client.charts.add_category(chart.key, category_to_add)

Javascript

const categoryToAdd = { key: 2, label: 'Category 2', color: '#bbbbbb', accessible: true }
await client.charts.addCategory(chart.key, categoryToAdd)

Go

category := events.Category{Key: events.CategoryKey{Key: 2}, Label: "Category 2", Color: "#bbbbbb", Accessible: true}
err := client.Charts.AddCategory(chartKey1, category)

{
    "key": "1",
    "label": "Category 1",
    "color": "#bbbbbb",
    "accessible": true
}

Response is either:

• 204 - No Content: if everything went well
• 400 - Bad Request if something was wrong with the request, check the response body for more information.
• 404 - Not Found: e.g. if the specified chart key does not exist

Removing a category

Text

curl -X DELETE https://api-{region}.seatsio.net/charts/{chartKey}/categories/{categoryKey} -u aSecretKey:

PHP

$seatsioClient->charts->removeCategory($chartKey, 1);
$seatsioClient->charts->removeCategory($chartKey, "cat2");

C#

await Client.Charts.RemoveCategoryAsync(chart.Key, 1);

Java

client.charts.removeCategory(chart.key, CategoryKey.of(1L));
client.charts.removeCategory(chart.key, CategoryKey.of("cat1"));

Python

client.charts.remove_category(chart.key, 1)
client.charts.remove_category(chart.key, "cat2")

Ruby

client.charts.remove_category(chart.key, 'cat2')

Javascript

await client.charts.removeCategory(chart.key, 'cat2')

Go

err = client.Charts.RemoveCategory(chart.Key, events.CategoryKey{Key: 1})

Response is either:

• 204 - No Content: if everything went well
• 400 - Bad Request if something was wrong with the request, check the response body for more information.
• 404 - Not Found: e.g. if the specified chart key does not exist, or if the category was not present on the chart.

Listing categories for a chart

Text

curl -X GET https://api-{region}.seatsio.net/charts/{chartKey}/categories -u aSecretKey:

PHP

$seatsioClient->charts->listCategories($chartKey);

C#

await Client.Charts.ListCategoriesAsync(chart.Key);

Java

List<Category> categories = client.charts.listCategories(chart.key);

Python

client.charts.list_categories(chart.key)

Ruby

client.charts.list_categories(chart.key)

Javascript

await client.charts.listCategories(chart.key)

Go

categories, err := client.Charts.ListCategories(chart.Key)

Response is either:

• 200 - OK: if everything went well
• 400 - Bad Request if something was wrong with the request, check the response body for more information.
• 404 - Not Found: e.g. if the specified chart key does not exist, or if the category was not present on the chart.

Updating a category

Text

curl -X PSOT https://api-{region}.seatsio.net/charts/{chartKey}/categories/{categoryKey} -u aSecretKey:

PHP

$seatsioClient->charts->updateCategory($chart->key, 1, new CategoryUpdateParams('Updated label', '#bbbbbb', true));

C#

await Client.Charts.UpdateCategoryAsync(chart.Key, 1, new CategoryUpdateParams("Updated label", "#bbbbbb", true));

Java

client.charts.updateCategory(chart.key, CategoryKey.of(1), new CategoryUpdateParams("Updated label", "#bbbbbb", true));

Python

client.charts.update_category(chart_key=chart.key, category_key=1, label="Updated label", color="#bbbbbb", accessible=True)

Ruby

client.charts.update_category(chart_key: chart.key, category_key: 1, label: "Updated label", color: "#bbbbbb", accessible: true)

Javascript

await client.charts.updateCategory(chart.key, 1, new CategoryUpdateParams().withLabel('Updated label').withColor('#bbbbbb').withAccessible(true))

Go

err := client.Charts.UpdateCategory(chartKey, events.CategoryKey{Key: 1}, charts.UpdateCategoryParams{
        Label:      "New label",
        Color:      "#bbbbbb",
        Accessible: false,
})

{
    "label": "Updated label",
    "color": "#bbbbbb",
    "accessible": true
}

Response is either:

• 204 - OK: if everything went well
• 400 - Bad Request if something was wrong with the request, check the response body for more information.
• 404 - Not Found: e.g. if the specified chart key does not exist, or if the category was not present on the chart.