# Списки направлений (гео списки)

<a id="get-v1-geo"></a>

Метод получения списка Гео списков пользователя

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/scrolls/v1/geo' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/geo-lists.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "ati_id": "string",
    "contact_id": 0,
    "description": "string",
    "elements": [
      {
        "city_id": 0,
        "city_name": "string",
        "country_id": 0,
        "country_name": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "owner_ati_id": "string",
        "region_id": 0,
        "region_name": "string"
      }
    ],
    "emoji": "string",
    "fixed": false,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_global": false,
    "name": "string",
    "personal": false,
    "type": 0
  }
]
```

**Описание полей ответа**
- `[].ati_id` — Идентификатор фирмы
- `[].contact_id` — Идентификатор контакта
- `[].description` — Описание списка
- `[].elements` — Элементы списка
- `[].elements[].city_id` — Идентификатор города
- `[].elements[].city_name` — Название города
- `[].elements[].country_id` — Идентификатор страны
- `[].elements[].country_name` — Название страны
- `[].elements[].id` — Идентификатор элемента Гео списка
- `[].elements[].list_id` — Идентификатор Гео списка
- `[].elements[].region_id` — Идентификатор региона
- `[].elements[].region_name` — Название региона
- `[].emoji` — Эмодзи (html-entity)
- `[].id` — Идентификатор списка
- `[].is_global` — Глобальный ли список
- `[].name` — Название списка
- `[].personal` — Персональный ли список
- `[].type` — Тип списка

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


<a id="get-v1-geo-{listId}"></a>

Метод получения Гео списка по идентификатору

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/scrolls/v1/geo/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/geo-lists.openapi.json)

**Пример ответа (200)**

```json
{
  "ati_id": "string",
  "contact_id": 0,
  "description": "string",
  "elements": [
    {
      "city_id": 0,
      "city_name": "string",
      "country_id": 0,
      "country_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_ati_id": "string",
      "region_id": 0,
      "region_name": "string"
    }
  ],
  "emoji": "string",
  "fixed": false,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_global": false,
  "name": "string",
  "personal": false,
  "type": 0
}
```

**Описание полей ответа**
- `ati_id` — Идентификатор фирмы
- `contact_id` — Идентификатор контакта
- `description` — Описание списка
- `elements` — Элементы списка
- `elements[].city_id` — Идентификатор города
- `elements[].city_name` — Название города
- `elements[].country_id` — Идентификатор страны
- `elements[].country_name` — Название страны
- `elements[].id` — Идентификатор элемента Гео списка
- `elements[].list_id` — Идентификатор Гео списка
- `elements[].region_id` — Идентификатор региона
- `elements[].region_name` — Название региона
- `emoji` — Эмодзи (html-entity)
- `id` — Идентификатор списка
- `is_global` — Глобальный ли список
- `name` — Название списка
- `personal` — Персональный ли список
- `type` — Тип списка

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


<a id="post-v1-geo-ids"></a>

Публичный метод получения Гео списков по идентификаторам

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/scrolls/v1/geo/ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/geo-lists.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "ati_id": "string",
    "contact_id": 0,
    "description": "string",
    "elements": [
      {
        "city_id": 0,
        "city_name": "string",
        "country_id": 0,
        "country_name": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "owner_ati_id": "string",
        "region_id": 0,
        "region_name": "string"
      }
    ],
    "emoji": "string",
    "fixed": false,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_global": false,
    "name": "string",
    "personal": false,
    "type": 0
  }
]
```

**Описание полей ответа**
- `[].ati_id` — Идентификатор фирмы
- `[].contact_id` — Идентификатор контакта
- `[].description` — Описание списка
- `[].elements` — Элементы списка
- `[].elements[].city_id` — Идентификатор города
- `[].elements[].city_name` — Название города
- `[].elements[].country_id` — Идентификатор страны
- `[].elements[].country_name` — Название страны
- `[].elements[].id` — Идентификатор элемента Гео списка
- `[].elements[].list_id` — Идентификатор Гео списка
- `[].elements[].region_id` — Идентификатор региона
- `[].elements[].region_name` — Название региона
- `[].emoji` — Эмодзи (html-entity)
- `[].id` — Идентификатор списка
- `[].is_global` — Глобальный ли список
- `[].name` — Название списка
- `[].personal` — Персональный ли список
- `[].type` — Тип списка

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


<a id="post-v1-geo"></a>

Метод добавления Гео списка

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/scrolls/v1/geo' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ati_id": "string",
  "contact_id": 0,
  "description": "string",
  "elements": [
    {
      "city_id": 0,
      "city_name": "string",
      "country_id": 0,
      "country_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_ati_id": "string",
      "region_id": 0,
      "region_name": "string"
    }
  ],
  "emoji": "string",
  "fixed": false,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_global": false,
  "name": "string",
  "personal": false,
  "type": 0
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/geo-lists.openapi.json)

**Описание полей запроса**
- `ati_id` — Идентификатор фирмы
- `contact_id` — Идентификатор контакта
- `description` — Описание списка
- `elements` — Элементы списка
- `elements[].city_id` — Идентификатор города
- `elements[].city_name` — Название города
- `elements[].country_id` — Идентификатор страны
- `elements[].country_name` — Название страны
- `elements[].id` — Идентификатор элемента Гео списка
- `elements[].list_id` — Идентификатор Гео списка
- `elements[].region_id` — Идентификатор региона
- `elements[].region_name` — Название региона
- `emoji` — Эмодзи (html-entity)
- `id` — Идентификатор списка
- `is_global` — Глобальный ли список
- `name` — Название списка
- `personal` — Персональный ли список
- `type` — Тип списка

**Пример ответа (200)**

```json
{
  "ati_id": "string",
  "contact_id": 0,
  "description": "string",
  "elements": [
    {
      "city_id": 0,
      "city_name": "string",
      "country_id": 0,
      "country_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_ati_id": "string",
      "region_id": 0,
      "region_name": "string"
    }
  ],
  "emoji": "string",
  "fixed": false,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_global": false,
  "name": "string",
  "personal": false,
  "type": 0
}
```

**Описание полей ответа**
- `ati_id` — Идентификатор фирмы
- `contact_id` — Идентификатор контакта
- `description` — Описание списка
- `elements` — Элементы списка
- `elements[].city_id` — Идентификатор города
- `elements[].city_name` — Название города
- `elements[].country_id` — Идентификатор страны
- `elements[].country_name` — Название страны
- `elements[].id` — Идентификатор элемента Гео списка
- `elements[].list_id` — Идентификатор Гео списка
- `elements[].region_id` — Идентификатор региона
- `elements[].region_name` — Название региона
- `emoji` — Эмодзи (html-entity)
- `id` — Идентификатор списка
- `is_global` — Глобальный ли список
- `name` — Название списка
- `personal` — Персональный ли список
- `type` — Тип списка

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


<a id="put-v1-geo"></a>

Метод изменения Гео списка

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/scrolls/v1/geo' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ati_id": "string",
  "contact_id": 0,
  "description": "string",
  "elements": [
    {
      "city_id": 0,
      "city_name": "string",
      "country_id": 0,
      "country_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_ati_id": "string",
      "region_id": 0,
      "region_name": "string"
    }
  ],
  "emoji": "string",
  "fixed": false,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_global": false,
  "name": "string",
  "personal": false,
  "type": 0
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/geo-lists.openapi.json)

**Описание полей запроса**
- `ati_id` — Идентификатор фирмы
- `contact_id` — Идентификатор контакта
- `description` — Описание списка
- `elements` — Элементы списка
- `elements[].city_id` — Идентификатор города
- `elements[].city_name` — Название города
- `elements[].country_id` — Идентификатор страны
- `elements[].country_name` — Название страны
- `elements[].id` — Идентификатор элемента Гео списка
- `elements[].list_id` — Идентификатор Гео списка
- `elements[].region_id` — Идентификатор региона
- `elements[].region_name` — Название региона
- `emoji` — Эмодзи (html-entity)
- `id` — Идентификатор списка
- `is_global` — Глобальный ли список
- `name` — Название списка
- `personal` — Персональный ли список
- `type` — Тип списка

**Пример ответа (200)**

```json
{
  "ati_id": "string",
  "contact_id": 0,
  "description": "string",
  "elements": [
    {
      "city_id": 0,
      "city_name": "string",
      "country_id": 0,
      "country_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_ati_id": "string",
      "region_id": 0,
      "region_name": "string"
    }
  ],
  "emoji": "string",
  "fixed": false,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_global": false,
  "name": "string",
  "personal": false,
  "type": 0
}
```

**Описание полей ответа**
- `ati_id` — Идентификатор фирмы
- `contact_id` — Идентификатор контакта
- `description` — Описание списка
- `elements` — Элементы списка
- `elements[].city_id` — Идентификатор города
- `elements[].city_name` — Название города
- `elements[].country_id` — Идентификатор страны
- `elements[].country_name` — Название страны
- `elements[].id` — Идентификатор элемента Гео списка
- `elements[].list_id` — Идентификатор Гео списка
- `elements[].region_id` — Идентификатор региона
- `elements[].region_name` — Название региона
- `emoji` — Эмодзи (html-entity)
- `id` — Идентификатор списка
- `is_global` — Глобальный ли список
- `name` — Название списка
- `personal` — Персональный ли список
- `type` — Тип списка

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


<a id="delete-v1-geo-{listId}"></a>

Метод удаляет список заданной фирмы

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/scrolls/v1/geo/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/geo-lists.openapi.json)

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


<a id="post-v1-geo-elements"></a>

Метод добавления элементов в Гео список

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/scrolls/v1/geo/elements' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  {
    "city_id": 0,
    "city_name": "string",
    "country_id": 0,
    "country_name": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "owner_ati_id": "string",
    "region_id": 0,
    "region_name": "string"
  }
]'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/geo-lists.openapi.json)

**Описание полей запроса**
- `[].city_id` — Идентификатор города
- `[].city_name` — Название города
- `[].country_id` — Идентификатор страны
- `[].country_name` — Название страны
- `[].id` — Идентификатор элемента Гео списка
- `[].list_id` — Идентификатор Гео списка
- `[].region_id` — Идентификатор региона
- `[].region_name` — Название региона

**Пример ответа (200)**

```json
[
  {
    "status": 0,
    "value": {
      "city_id": 0,
      "city_name": "string",
      "country_id": 0,
      "country_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_ati_id": "string",
      "region_id": 0,
      "region_name": "string"
    }
  }
]
```

**Описание полей ответа**
- `[].status` — Статус: 0 - успешно; 2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; 4 - такой список не найден; 6 - такой элемент уже есть в этом списке
- `[].value.city_id` — Идентификатор города
- `[].value.city_name` — Название города
- `[].value.country_id` — Идентификатор страны
- `[].value.country_name` — Название страны
- `[].value.id` — Идентификатор элемента Гео списка
- `[].value.list_id` — Идентификатор Гео списка
- `[].value.region_id` — Идентификатор региона
- `[].value.region_name` — Название региона

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


<a id="delete-v1-geo-elements"></a>

Метод удаления элементов из списков по их идентификаторам

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/scrolls/v1/geo/elements' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/geo-lists.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "status": 0,
    "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]
```

**Описание полей ответа**
- `[].status` — Статус: 0 - успешно; 2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; 4 - такой список не найден; 6 - такой элемент уже есть в этом списке
- `[].value` — Значение

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```
---

## llms.txt

Индекс ключевых страниц документации для LLM и AI-агентов доступен в [основном llms.txt](https://ati.su/developers/llms.txt).