API Справочники

Работа со справочниками.

Формы собственности

Метод «getOwnershipFormsList», работает в модели «Common», этот метод позволяет загрузить список форм собственности на Украинском языке. Необходимо сохранять копию справочников на стороне клиента и поддерживать ее в актуальном состоянии. Рекомендуется проводить обновление справочников раз в месяц.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

(дополнительный)
string

Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties string Свойства метода
* Обозначение обязательного параметра 

{
"modelName": "Common",
"calledMethod": "getOwnershipFormsList",
"apiKey": "[ВАШ КЛЮЧ]",
"methodProperties": {}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>getOwnershipFormsList</calledMethod>
<methodProperties />
<modelName>Common</modelName>
</file>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref string[36] Идентификатор
Description string[36] Описание на Украинском 

{
   "success": "true",
   "data": [
      {
         "Ref": "7f0f3516-2519-11df-be9a-000c291af1b3",
         "Description": "ПК",
         "FullName": "Производственный кооператив"
      },
      {
         "Ref": "7f0f3515-2519-11df-be9a-000c291af1b3",
         "Description": "ГП",
         "FullName": "Государственное предприятие"
      },
      {
         "Ref": "7f0f3518-2519-11df-be9a-000c291af1b3",
         "Description": "КП",
         "FullName": "Коммунальное предприятие"
      },
      {
         "Ref": "10d78dad-2352-11e2-83ab-d4ae52ab9fab",
         "Description": "КО",
         "FullName": "Коммандитное общество"
      },
      {
         "Ref": "361b83db-886e-11e1-a146-0026b97ed48a",
         "Description": "ПАО",
         "FullName": "Публичное акционерное общество"
      },
      {
         "Ref": "9252696e-2202-11e4-acce-0050568002cf",
         "Description": "ПИИ",
         "FullName": "Предприятие с иностранными инвестициями"
      },
      {
         "Ref": "7f0f3519-2519-11df-be9a-000c291af1b3",
         "Description": "ЧП",
         "FullName": "Частное предприятие (не частный предприниматель)"
      },
      {
         "Ref": "b0b2c790-8920-11e1-8429-0026b97ed48a",
         "Description": "ЧАО",
         "FullName": "Акционерное общество (ПАО, ЧАО, ОАО, ЗАО)"
      },
      {
         "Ref": "7f0f3514-2519-11df-be9a-000c291af1b3",
         "Description": "ПО",
         "FullName": "Полное общество"
      },
      {
         "Ref": "7f0f351a-2519-11df-be9a-000c291af1b3",
         "Description": "СП",
         "FullName": "Совместное предприятие"
      },
      {
         "Ref": "7f0f351c-2519-11df-be9a-000c291af1b3",
         "Description": "ОДО",
         "FullName": ", Общество с дополнительной ответственностью"
      },
      {
         "Ref": "7f0f351d-2519-11df-be9a-000c291af1b3",
         "Description": "ООО",
         "FullName": ", Общество с ограниченной ответственностью"
      },
      {
         "Ref": "7f0f3517-2519-11df-be9a-000c291af1b3",
         "Description": "ФХ",
         "FullName": "Фермерское хозяйство"
      },
      {
         "Ref": "7f0f351e-2519-11df-be9a-000c291af1b3",
         "Description": "ФЛП (СПД)",
         "FullName": "Физ. Лицо-предприниматель (только частный предприниматель)"
      }
   ],
   "errors": [],
   "warnings": [],
   "info": []
}
<root>
	<success>true</success>
	<data>
		<item>
			<Ref>7f0f3516-2519-11df-be9a-000c291af1b3</Ref>
			<Description>ПК</Description>
			<FullName>Производственный кооператив</FullName>
		</item>
		<item>
			<Ref>7f0f3515-2519-11df-be9a-000c291af1b3</Ref>
			<Description>ГП</Description>
			<FullName>Государственное предприятие</FullName>
		</item>
		<item>
			<Ref>7f0f3518-2519-11df-be9a-000c291af1b3</Ref>
			<Description>КП</Description>
			<FullName>Коммунальное предприятие</FullName>
		</item>
		<item>
			<Ref>10d78dad-2352-11e2-83ab-d4ae52ab9fab</Ref>
			<Description>КО</Description>
			<FullName>Коммандитное общество</FullName>
		</item>
		<item>
			<Ref>361b83db-886e-11e1-a146-0026b97ed48a</Ref>
			<Description>ПАО</Description>
			<FullName>Публичное акционерное общество</FullName>
		</item>
		<item>
			<Ref>9252696e-2202-11e4-acce-0050568002cf</Ref>
			<Description>ПИИ</Description>
			<FullName>Предприятие с иностранными инвестициями</FullName>
		</item>
		<item>
			<Ref>7f0f3519-2519-11df-be9a-000c291af1b3</Ref>
			<Description>ЧП</Description>
			<FullName>Частное предприятие (не частный предприниматель)</FullName>
		</item>
		<item>
			<Ref>b0b2c790-8920-11e1-8429-0026b97ed48a</Ref>
			<Description>ЧАО</Description>
			<FullName>Акционерное общество (ПАО, ЧАО, ОАО, ЗАО)</FullName>
		</item>
		<item>
			<Ref>7f0f3514-2519-11df-be9a-000c291af1b3</Ref>
			<Description>ПО</Description>
			<FullName>Полное общество</FullName>
		</item>
		<item>
			<Ref>7f0f351a-2519-11df-be9a-000c291af1b3</Ref>
			<Description>СП</Description>
			<FullName>Совместное предприятие</FullName>
		</item>
		<item>
			<Ref>7f0f351c-2519-11df-be9a-000c291af1b3</Ref>
			<Description>ОДО</Description>
			<FullName>, Общество с дополнительной ответственностью</FullName>
		</item>
		<item>
			<Ref>7f0f351d-2519-11df-be9a-000c291af1b3</Ref>
			<Description>ООО</Description>
			<FullName>, Общество с ограниченной ответственностью</FullName>
		</item>
		<item>
			<Ref>7f0f3517-2519-11df-be9a-000c291af1b3</Ref>
			<Description>ФХ</Description>
			<FullName>Фермерское хозяйство</FullName>
		</item>
		<item>
			<Ref>7f0f351e-2519-11df-be9a-000c291af1b3</Ref>
			<Description>ФЛП (СПД)</Description>
			<FullName>Физ. Лицо-предприниматель (только частный предприниматель)</FullName>
		</item>
	</data>
	<errors />
	<warnings />
	<info />
</root>