List the saved structure sets of the organisation
GET /api/v1/structure-sets
https://app.tanba-ooh.kz/api/v1/structure-sets
Технический текст справочника написан на английском.
Scope write:submissions. A structure set is a named list of structures that a submission can name with structure_set_ids instead of listing every structure. The server expands a set into explicit structure codes; an approval and its envelope never carry a set, so a screen added later needs a new approval.
Аутентификация
Ключ API в заголовке Authorization или сессия консоли.
Право доступа: write:submissions
Ответы
200 The sets of the organisation, ordered by name.
application/json
| Имя | Тип | Обязательный | Описание | Пример |
|---|---|---|---|---|
items | array of StructureSet | да | The saved sets of the organisation. | |
items[].id | string (uuid) | да | Id of the set. | "5d3f3e0a-2a53-4b3c-8d0a-6f63b4d9a111" |
items[].name | string | да | Name, unique within the organisation. | "Almaty city boards" |
items[].structure_ids | array of string (uuid) | да | Structures of the set in the order given. | ["0b6f9d0e-6c1e-4a6a-9d55-0f8a6a6f3c11"] |
items[].created_at | string | да | When the set was saved first. | "2026-10-14T10:00:00+05:00" |
items[].updated_at | string | да | When the set was last changed. | "2026-10-14T10:00:00+05:00" |
Пример
{
"items": [
{
"id": "5d3f3e0a-2a53-4b3c-8d0a-6f63b4d9a111",
"name": "Almaty city boards",
"structure_ids": [
"0b6f9d0e-6c1e-4a6a-9d55-0f8a6a6f3c11"
],
"created_at": "2026-10-14T10:00:00+05:00",
"updated_at": "2026-10-14T10:00:00+05:00"
}
]
}
Ошибки
Ошибки приходят документом problem (application/problem+json) со стабильным полем code.
| Статус | Значение |
|---|---|
| 401 | Нет действительной сессии или ключа API (unauthenticated, session_expired, invalid_api_key). |
| 403 | Роль или право ключа этого не допускает (forbidden, key_scope_denied, key_route_denied). |
| default | Ошибка в виде документа problem. |
Примеры кода
curl
curl 'https://app.tanba-ooh.kz/api/v1/structure-sets' \
-H 'Authorization: Bearer YOUR_API_KEY'
Python
import requests
response = requests.get(
"https://app.tanba-ooh.kz/api/v1/structure-sets",
headers={
"Authorization": "Bearer YOUR_API_KEY",
},
)
print(response.status_code, response.text)
Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://app.tanba-ooh.kz/api/v1/structure-sets", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, _ := io.ReadAll(resp.Body)
fmt.Println(resp.Status, string(data))
}