Документация API / версия 1 / 8603032896-mspsupport

Документация API по работе с набором открытых данных


Идентификатор набора: 8603032896-mspsupport

Наименование набора: Сведения о мерах поддержки малого и среднего предпринимательства в городе Нижневартовске


С чего начать?

Для работы с API Вам потребуется уникальный ключ доступа. Чтобы получить его — пройдите несложную процедуру идентификации на портале.

Использование ключа доступа

API доступен только зарегистрированным разработчикам. Ключ доступа может передаваться любым из предложенных вариантов:
      в HTTP Header, в формате Authorization-Token: 'API_KEY:<ваш ключ>'.
      в GET-запросе, в формате ?api_key=<ваш ключ>.

Токен (api_key) можно посмотреть в профиле пользователя портала.



Для работы с набором открытых данных предусмотренны следующие API:


Значение
Формат
Адрес
Паспорт набора
JSON     HTML
/api/v1/8603032896-mspsupport/passport
Структура набора
JSON
/api/v1/8603032896-mspsupport/structure
Данные набора
JSON
/api/v1/8603032896-mspsupport/data[?param=value]


Паспорт набора

Паспорт набора - cовокупность сведений о наборе открытых данных, позволяющая однозначно идентифицировать такой набор и получить в автоматическом режиме ключевые параметры, характеризующие набор открытых данных.

Машиночитаемый паспорт открытых данных имеет структуру в формате JSON.

Запрос:
Ответ:
Загрузка...


Структура набора

Структура набора - совокупность сведений о полях набора открытых данных.

Машиночитаемая структура набора открытых данных имеет следующий вид:

Наименование поля
Тип данных
Значение поля
A
String
Организация, предоставляющая меру поддержки
B
String
Вид меры поддержки
C
String
Наименование меры поддержки
D
String
Жизненная ситуация
E
String
Получатели поддержки
F
String
Описание образовательной программы
G
String
Место регистрации заявителя
H
String
Наличие регистрации заявителя в Едином реестре субъектов малого и среднего предпринимательства Федеральной налоговой службы Российской Федерации
I
String
Отсутствие просроченной задолженности у заявителя по начисленным налогам, сборам, соответствующим пеням, штрафам на дату подачи заявки на предоставление поручительства
J
String
Отсутствие задолженности (согласно официальной информации, образовавшейся в силу неисполнения субъектом и (или) его учредителями, участниками, членами принятых на себя кредитных обязательств
K
String
Отсутствие за 3 (три) месяца, предшествующих дате обращения за получением поддержки, нарушений условий ранее заключенных кредитных договоров, договоров лизинга, договоров о предоставлении банковской гарантии и т.п.
L
String
Субъект не находится в стадии ликвидации, реорганизации, несостоятельности (банкротства)
M
String
Условия получения поддержки
N
String
Виды деятельности
O
String
Размер финансовой поддержки и вознаграждение Фонда
P
String
Перечень документов, предоставляемых заявителем
Q
String
Сроки получения поддержки
R
String
Правовые основания
S
String
Выручка на конец года
T
String
Возраст компании
U
String
Другие реестры юр. Лиц
V
String
Количество сотрудников
W
String
Наименование параметра 1
X
String
Значение Параметра 1 мин
Y
String
Значение Параметра 1 макс
Z
String
Наименование параметра 2
AA
String
Значение Параметра 2 мин
AB
String
Значение Параметра 2 макс
AC
String
Наименование параметра 3
AD
String
Значение Параметра 3 мин
AE
String
Значение Параметра 3 макс

Запрос:
Ответ:
Загрузка...




Данные набора

Данные набора — систематизированная совокупность однотипных данных, представленных в форме открытых данных, состоящая из отдельных элементов, характеризующихся набором атрибутов, и позволяющая автоматизированным системам без участия человека идентифицировать, интерпретировать и обрабатывать такие элементы

Входящие параметры запроса API-Запроса имеет следующий вид:

Параметр
Тип данных
Значение
ROWS
Integer
Количество строк, содержащихся в ответе запроса (может использоваться для навигации по данным
PAGE
Integer
Номер страницы (может использоваться для навигации по данным)
Q
String
Поисковый фильтр, ограничивающий результаты запроса (полнотекстовый поиск по подстроке)

Пример API-запроса: https://data.n-vartovsk.ru/api/v1/8603032896-mspsupport/data?ROWS=2&PAGE=2



Дополнительный поиск по набору осуществляется по следующим полям: A.

Пример API-запроса: https://data.n-vartovsk.ru/api/v1/8603032896-mspsupport/data?A=значение



Ответ на запрос API-запрос

Структура ответа на API-запрос имеет следующий вид:

{
	"STATUS": CODE,
	"RESULT": - OBJECT,		
}
где
	CODE - Код ответа HTTP (200,400,403,404,500)
	OBJECT - Объект, имеющий следующую структуру:
	{
		"META" : {	 Мета информация, описывающая ответ
			"ROWS" : Integer		количество строк
			"PAGE" : Integer		номер страницы
			"ROWS_TOTAL" : Integer		общее количество строк, находящихся в ответе
			"PAGE_TOTAL" : Integer		общее количество страниц, находящихся в ответе
		},
		"ROWS" : [
			{ОБЪЕКТ}
		]
	}
	


Запрос:
Ответ:
Загрузка...