# Для работы с АТИ-Доками

Каждый метод возвращает список элементов с идентификатором и атрибутами. Состав атрибутов и их описания приведены в схеме ответа.

#### Типы договоров

<a id="get-v1-dictionaries-ati_docs_contract_types"></a>

**Версия: Bearer token**

Получение словаря ati_docs_contract_types

Типы договоров для работы с АТИ-Доками

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

```bash
curl 'https://api.ati.su/gw/dictionaries/v1/ati_docs_contract_types?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

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

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

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

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Договор транспортной экспедиции"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название вида договора

<a id="get-v1-dictionaries-ati_docs_contract_types"></a>

**Версия: OAuth2.0**

Получение словаря ati_docs_contract_types

Типы договоров для работы с АТИ-Доками

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

```bash
curl 'https://api.ati.su/gw/oauth2/dictionaries/v1/ati_docs_contract_types?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

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

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

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

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Договор транспортной экспедиции"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название вида договора


#### Типы документов

<a id="get-v1-dictionaries-ati_docs_document_types"></a>

**Версия: Bearer token**

Получение словаря ati_docs_document_types

Типы документов для работы с АТИ-Доками, например заказ, заявка к договору и доверенность. Табличные варианты заказа и заявки выделены в отдельные типы

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

```bash
curl 'https://api.ati.su/gw/dictionaries/v1/ati_docs_document_types?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

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

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

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

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "заказ (табличный вид)"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название типа документа

<a id="get-v1-dictionaries-ati_docs_document_types"></a>

**Версия: OAuth2.0**

Получение словаря ati_docs_document_types

Типы документов для работы с АТИ-Доками, например заказ, заявка к договору и доверенность. Табличные варианты заказа и заявки выделены в отдельные типы

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

```bash
curl 'https://api.ati.su/gw/oauth2/dictionaries/v1/ati_docs_document_types?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

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

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

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

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "заказ (табличный вид)"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название типа документа


#### Статусы ЭТрН

<a id="get-v1-dictionaries-etrn_list_statuses"></a>

**Версия: Bearer token**

Получение словаря etrn_list_statuses

Состояния электронного документооборота транспортной накладной: код состояния, его название и этап маршрута, если он указан

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

```bash
curl 'https://api.ati.su/gw/dictionaries/v1/etrn_list_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

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

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

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

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "code": "title_1_success",
      "docflow_status": "Ожидает подписи перевозчика",
      "route_status": "Титул 2. Перевозчик (прием груза)"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.code` — Код состояния документооборота ЭТрН. Позволяет различать состояния при обработке данных
- `[].attributes.docflow_status` — Название состояния документооборота для отображения пользователю
- `[].attributes.route_status` — Название этапа маршрута. Может быть пустой строкой

<a id="get-v1-dictionaries-etrn_list_statuses"></a>

**Версия: OAuth2.0**

Получение словаря etrn_list_statuses

Состояния электронного документооборота транспортной накладной: код состояния, его название и этап маршрута, если он указан

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

```bash
curl 'https://api.ati.su/gw/oauth2/dictionaries/v1/etrn_list_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

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

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

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

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "code": "title_1_success",
      "docflow_status": "Ожидает подписи перевозчика",
      "route_status": "Титул 2. Перевозчик (прием груза)"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.code` — Код состояния документооборота ЭТрН. Позволяет различать состояния при обработке данных
- `[].attributes.docflow_status` — Название состояния документооборота для отображения пользователю
- `[].attributes.route_status` — Название этапа маршрута. Может быть пустой строкой
---

## llms.txt

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