Документация API / версия 1 / 8603032896-listoumd
Документация API по работе с набором открытых данных
Идентификатор набора: 8603032896-listoumd
Наименование набора: Информация об управляющих компаниях МО г. Нижневартовск
С чего начать?
Для работы с API Вам потребуется уникальный ключ доступа. Чтобы получить его — пройдите несложную процедуру идентификации на портале.
Использование ключа доступа
API доступен только зарегистрированным разработчикам.
Ключ доступа может передаваться любым из предложенных вариантов:
в HTTP Header, в формате
Authorization-Token: 'API_KEY:<ваш ключ>'.
в GET-запросе, в формате ?api_key=<ваш ключ>.
Токен (api_key) можно посмотреть в профиле пользователя портала.
Для работы с набором открытых данных предусмотренны следующие API:
- Значение
- Формат
- Адрес
- Паспорт набора
- JSON HTML
- /api/v1/8603032896-listoumd/passport
- Структура набора
- JSON
- /api/v1/8603032896-listoumd/structure
- Данные набора
- JSON
- /api/v1/8603032896-listoumd/data[?param=value]
Паспорт набора
Паспорт набора - cовокупность сведений о наборе открытых данных, позволяющая однозначно идентифицировать такой набор и получить в автоматическом режиме ключевые параметры, характеризующие набор открытых данных.
Загрузка...
Структура набора
Структура набора - совокупность сведений о полях набора открытых данных.
Машиночитаемая структура набора открытых данных имеет следующий вид:- Наименование поля
- Тип данных
- Значение поля
- CITY
- String
- Населенный пункт
- INN
- String
- ИНН
- OGRN
- String
- ОГРН
- TITLE
- String
- Полное наименование
- TITLESM
- String
- Сокращенное наименование учреждения
- FIO
- String
- ФИО руководителя
- String
- Адрес электронной почты
- URL
- String
- Ссылка на сайт
- ADR
- String
- Адрес
- TEL
- String
- Контактный телефон
- WORK_TIME
- String
- Режим работы
- CNT
- int
- Количество домов в управлении
- MKD
- Array
- Список домов, которые обслуживаются этой компанией
Запрос: Ответ:
Загрузка...Данные набора
Данные набора — систематизированная совокупность однотипных данных, представленных в форме открытых данных, состоящая из отдельных элементов, характеризующихся набором атрибутов, и позволяющая автоматизированным системам без участия человека идентифицировать, интерпретировать и обрабатывать такие элементы
Входящие параметры запроса API-Запроса имеет следующий вид:
- Параметр
- Тип данных
- Значение
- ROWS
- Integer
- Количество строк, содержащихся в ответе запроса (может использоваться для навигации по данным
- PAGE
- Integer
- Номер страницы (может использоваться для навигации по данным)
- Q
- String
- Поисковый фильтр, ограничивающий результаты запроса (полнотекстовый поиск по подстроке)
Пример API-запроса: https://data.n-vartovsk.ru/api/v1/8603032896-listoumd/data?ROWS=2&PAGE=2
Ответ на запрос 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" : [
{ОБЪЕКТ}
]
}
Запрос: Ответ:
Загрузка...
Ok