Skip to content
Мои токены Поддержка
Чат для вопросов по API Мгновенно ответим на ваши вопросы
api@ati.su Электронная почта техподдержки
Тикетная система Оставить заявку на отдел "Консультанты по интеграции (API)"
api.ati.su - заказы, торги, площадки Наш телеграм-канал
Авторизоваться
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
Отменить

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

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

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

Получение списка ОПФ
get /v1.0/dictionaries/ownerships
Запрос
Пример запроса 
curl 'https://api.ati.su/v1.0/dictionaries/ownerships' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Список организационно-правовых форм
Модель
[{...}]
Id: int64

Id

Id2: guid

Guid

Name: string

Название

FullName: string

Полное название

}]
Пример
[...]
{...}
"Id":0,
"Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Name":"string",
"FullName":"string"
}
]

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

Метод получения профилей деятельности фирм
get /v1.0/firms/dictionaries/account/firmtypes
Запрос
Пример запроса 
curl 'https://api.ati.su/v1.0/firms/dictionaries/account/firmtypes' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
[{...}]

Структура "Профиль деятельности".

id: int32

Идентификатор типа фирмы.

name: string (nullable)

Название типа

russian_name: string (nullable)

Название типа.

english_name: string (nullable)

Английское название типа.

enable_for_registration: boolean

Флаг, означающий, что данный профиль деятельности доступен для выбора при регистрации.

}]
Пример
[...]
{...}
"id":0,
"name":"string",
"russian_name":"string",
"english_name":"string",
"enable_for_registration":false
}
]
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод получения профилей деятельности фирм
get /v1.0/firms/dictionaries/account/firmtypes/{id}
Запрос
Пример запроса 
curl 'https://api.ati.su/v1.0/firms/dictionaries/account/firmtypes/{id}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
{...}

Структура "Профиль деятельности".

id: int32

Идентификатор типа фирмы.

name: string (nullable)

Название типа

russian_name: string (nullable)

Название типа.

english_name: string (nullable)

Английское название типа.

enable_for_registration: boolean

Флаг, означающий, что данный профиль деятельности доступен для выбора при регистрации.

}
Пример
{...}
"id":0,
"name":"string",
"russian_name":"string",
"english_name":"string",
"enable_for_registration":false
}
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}

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

Метод получения списка стран
get /v1.0/firms/requisites/countries
Запрос
Пример запроса 
curl 'https://api.ati.su/v1.0/firms/requisites/countries' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
[{...}]
id: int32
name: string (nullable)
short_name: string (nullable)
}]
Пример
[...]
{...}
"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 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод получения возможных элементов адреса
get /v1.0/firms/requisites/addressparts
Запрос
Пример запроса 
curl 'https://api.ati.su/v1.0/firms/requisites/addressparts' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
{...}

Типы адресов.

}
Пример
{...}
"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"
}
]
}
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод получения форм собственности страны
get /v1.0/firms/requisites/ownerships/{countryId}
Запрос
Пример запроса 
curl 'https://api.ati.su/v1.0/firms/requisites/ownerships/{countryId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
[{...}]
id: int32
name: string (nullable)
name_eng: string (nullable)
short_name: string (nullable)
short_name_eng: string (nullable)
ownership_type: string (nullable)
read only
ownership_type_name: string (nullable)
read only
requisite_types: [int32]
}]
Пример
[...]
{...}
"id":0,
"name":"string",
"name_eng":"string",
"short_name":"string",
"short_name_eng":"string",
"requisite_types":[...]
0
]
}
]
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}