Поиск по сайту

API
Главная / API - Поиск ОПФ

Поиск ОПФ

Обновлено 11.06.2021
88 кб

Общие сведения

Данный справочник содержит перечень видов организационно-правовых форм (ОПФ).

Поиск ОПФ

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/references/opf_list.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "title":"Отк",
   "name":"ОАО",
   "countryUID":"0x8f51001438c4d49511dbd774581edb7a"
}

Адрес метода: https://api.dellin.ru/v1/references/opf_list.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <title>Отк</title>
   <name>ОАО</name>
   <countryUID>0x8f51001438c4d49511dbd774581edb7a</countryUID>
</request>

Описание параметров

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
titleНет*string

Полное название ОПФ или его часть. Минимальная длина строки - 3 символа.

Поиск осуществляется как по началу, так и по середине строки.

*Запрос может содержать только один из параметров: "title" или "name"

nameНет*string

Краткое наименование ОПФ (ООО, ОАО и т. п.).

Поиск осуществляется с начала строки, точное совпадение обязательно

*Запрос может содержать только один из параметров: "title" или "name"

countryUIDНетstringUID страны, см. "Поиск стран"

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "uid":"0x8390b2048d37e0154b845fb22793e865",
         "name":"ОАО",
         "juridical":"true",
         "title":"Открытое Акционерное Общество",
         "innLength":10,
         "countryUID":"0x8f51001438c4d49511dbd774581edb7a"
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <uid>0x8390b2048d37e0154b845fb22793e865</uid>
      <name>ОАО</name>
      <juridical>true</juridical>
      <title>Открытое Акционерное Общество</title>
      <innLength>10</innLength>
      <countryUID>0x8f51001438c4d49511dbd774581edb7a</countryUID>
   </data>
</response>

Описание параметров

Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200"
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataИнформация об ОПФ
data.uidstringUID ОПФ
data.namestringКраткое наименование ОПФ (ООО, ОАО и т. п.)
data.juridicalboolean

Флаг обозначающий, что ОПФ является юридическим лицом

data.titlestringПолное наименование ОПФ
data.innLengthintegerНеобходимое количество цифр в ИНН
data.countryUIDstringUID страны, см. "Поиск стран"

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".