# Словари для работы с фирмами

### Получение списка организационно-правовых форм (ОПФ)

Каждой организационно-правовой форме присвоен свой уникальный идентификатор в базе данных ATI.SU. Воспользуйтесь словарем списка ОПФ, чтобы найти нужные id.

<a id="get-v1.0-dictionaries-ownerships"></a>

Получение списка ОПФ

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

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

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

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

```json
[
  {
    "Id": 0,
    "Id2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name": "string",
    "FullName": "string"
  }
]
```

**Описание полей ответа**
- `[].Id` — Id
- `[].Id2` — Guid
- `[].Name` — Название
- `[].FullName` — Полное название


### Словари аккаунта

<a id="get-v1.0-firms-dictionaries-account-firmtypes"></a>

Метод получения профилей деятельности фирм

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

```bash
curl 'https://api.ati.su/v1.0/firms/dictionaries/account/firmtypes?enableForRegistration=false' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

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

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

```json
[
  {
    "id": 0,
    "name": "string",
    "russian_name": "string",
    "english_name": "string",
    "enable_for_registration": false
  }
]
```

**Описание полей ответа**
- `[].id` — Идентификатор типа фирмы.
- `[].name` — Название типа
- `[].russian_name` — Название типа.
- `[].english_name` — Английское название типа.
- `[].enable_for_registration` — Флаг, означающий, что данный профиль деятельности доступен для выбора при регистрации.

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

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


<a id="get-v1.0-firms-dictionaries-account-firmtypes-{id}"></a>

Метод получения профилей деятельности фирм

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

```bash
curl 'https://api.ati.su/v1.0/firms/dictionaries/account/firmtypes/0' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

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

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

```json
{
  "id": 0,
  "name": "string",
  "russian_name": "string",
  "english_name": "string",
  "enable_for_registration": false
}
```

**Описание полей ответа**
- `id` — Идентификатор типа фирмы.
- `name` — Название типа
- `russian_name` — Название типа.
- `english_name` — Английское название типа.
- `enable_for_registration` — Флаг, означающий, что данный профиль деятельности доступен для выбора при регистрации.

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

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


### Словари реквизитов

<a id="get-v1.0-firms-requisites-countries"></a>

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

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

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

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

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

```json
[
  {
    "id": 0,
    "name": "string",
    "short_name": "string",
    "default_ownership": {
      "id": 0,
      "name": "string",
      "name_eng": "string",
      "short_name": "string",
      "short_name_eng": "string",
      "requisite_types": [
        0
      ]
    }
  }
]
```

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

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


<a id="get-v1.0-firms-requisites-addressparts"></a>

Метод получения возможных элементов адреса

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

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

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

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

```json
{
  "street_types": [
    {
      "id": 0,
      "name": "string",
      "short_name": "string"
    }
  ],
  "building_types": [
    {
      "id": 0,
      "name": "string",
      "short_name": "string"
    }
  ],
  "building_part_types": [
    {
      "id": 0,
      "name": "string",
      "short_name": "string"
    }
  ],
  "room_types": [
    {
      "id": 0,
      "name": "string",
      "short_name": "string"
    }
  ]
}
```

**Описание полей ответа**
- `street_types` — Коллекция типов улиц (например, проспект).
- `street_types[].id` — Идентификатор элемента адреса
- `street_types[].name` — Название элемента адреса
- `street_types[].short_name` — Короткое название элемента адреса
- `building_types` — Коллекция типов зданий (например, дом).
- `building_types[].id` — Идентификатор элемента адреса
- `building_types[].name` — Название элемента адреса
- `building_types[].short_name` — Короткое название элемента адреса
- `building_part_types` — Коллекция типов строений (например, корпус).
- `building_part_types[].id` — Идентификатор элемента адреса
- `building_part_types[].name` — Название элемента адреса
- `building_part_types[].short_name` — Короткое название элемента адреса
- `room_types` — Коллекция типов помещений (например, офис).
- `room_types[].id` — Идентификатор элемента адреса
- `room_types[].name` — Название элемента адреса
- `room_types[].short_name` — Короткое название элемента адреса

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

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


<a id="get-v1.0-firms-requisites-ownerships-{countryId}"></a>

Метод получения форм собственности страны

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

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

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

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

```json
[
  {
    "id": 0,
    "name": "string",
    "name_eng": "string",
    "short_name": "string",
    "short_name_eng": "string",
    "requisite_types": [
      0
    ]
  }
]
```

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

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

## llms.txt

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