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

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

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

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

get

/v1.0/dictionaries/ownerships

CURL

Копировать

Пример ответа

Ответ

200 Список организационно-правовых форм

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"Id":0,

"Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name":"string",

"FullName":"string"

}

]

[{...}]

Id: int64

Id2: guid

Guid

Name: string

Название

FullName: string

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

}]

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/dictionaries/account/firmtypes

enableForRegistration

boolean

Доступность профиля при регистрации

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":0,

"name":"string",

"russian_name":"string",

"english_name":"string",

"enable_for_registration":false

}

]

[{...}]

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

id: int32

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

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

russian_name: string (nullable)

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

english_name: string (nullable)

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

enable_for_registration: boolean

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

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/v1.0/firms/dictionaries/account/firmtypes/{id}

int32

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"id":0,

"name":"string",

"russian_name":"string",

"english_name":"string",

"enable_for_registration":false

}

{...}

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

id: int32

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

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

russian_name: string (nullable)

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

english_name: string (nullable)

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

enable_for_registration: boolean

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

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/requisites/countries

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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":[...]

]

}

]

[{...}]

id: int32

short_name: string (nullable)

default_ownership:{...}

id: int32

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]

}

ownerships:[{...}]

id: int32

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]

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/v1.0/firms/requisites/addressparts

CURL

Копировать

Пример ответа

Ответ

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"

}

]

}

{...}

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

street_types:[{...}]

Коллекция типов улиц (например, проспект).

id: int32

Идентификатор элемента адреса

Название элемента адреса

short_name: string (nullable)

Короткое название элемента адреса

}]

building_types:[{...}]

Коллекция типов зданий (например, дом).

id: int32

Идентификатор элемента адреса

Название элемента адреса

short_name: string (nullable)

Короткое название элемента адреса

}]

building_part_types:[{...}]

Коллекция типов строений (например, корпус).

id: int32

Идентификатор элемента адреса

Название элемента адреса

short_name: string (nullable)

Короткое название элемента адреса

}]

room_types:[{...}]

Коллекция типов помещений (например, офис).

id: int32

Идентификатор элемента адреса

Название элемента адреса

short_name: string (nullable)

Короткое название элемента адреса

}]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/v1.0/firms/requisites/ownerships/{countryId}

countryId

int32

Идентификатор страны

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":0,

"name":"string",

"name_eng":"string",

"short_name":"string",

"short_name_eng":"string",

"requisite_types":[...]

]

}

]

[{...}]

id: int32

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]

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...