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

API
Главная / API - Search of forms of organization

Search of forms of organization

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

General information

The directory contains the list of legal forms of organization.

Search of legal forms of organization

Method request

Request example

Method address: https://api.dellin.ru/v1/references/opf_list.json

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

Method address: 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>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register
titleNo*string

Full legal form name or its fragment. Minimum string length - 3 characters.

Search by the beginning and by the end of the string.

*Only one of the following parameters can be passed in a request: "title" or "name"

nameNo*string

Short name of the legal form (ООО, ОАО, etc.).

Search from the beginning of the string, exact match is required.

*Only one of the following parameters can be passed in a request: "title" or "name"

countryUIDNostringCountry UID, see "Countries search"

Method response

Response example

{
   "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>

Description of parameters

Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusintegerEmulated status http-code. If successful, code 200 is returned
metadata.generated_atstring

Server response date and time.

Format: YYYY-MM-DD HH:MM:SS

dataarray of DataInformation on legal form
data.uidstringLegal form UID
data.namestringShort name of the legal form (ООО, ОАО, etc.)
data.juridicalbooleanLegal entity indicator
data.titlestringFull legal form name
data.innLengthintegerRequired number of digits in TIN
data.countryUIDstringCountry UID, see "Countries search"

Error handling

The common API errors are used with the method, for errors format description and errors list see Errors of API methods.