Благодарим Вас за проявленный интерес к API Портала открытых данных Республики Коми

Форматом ответа API является JSON.

Настоящая версия API реализована с частичной поддержкой протокола Open Data Protocol (OData). Более подробно с описанием протокола Вы можете ознакомиться на сайте http://www.odata.org/. Указанные ниже параметры протокола OData поддерживаются всеми ресурсами данной версии API. Они являются необязательными, однако их использование может значительно упростить работу с API Портала.

Параметры:

В ссылках на все ресурсы API Портала открытых данных Республики Коми должна содержаться информация об используемой версии в формате http://opendata.rkomi.ru/opendataapi/v{version}. Номер текущей версии можно узнать при помощи запроса, указанного ниже.

Запрос:

Ответ:

Таким образом, базовый URL для всех ресурсов в текущей версии API — http://opendata.rkomi.ru/opendataapi/v1/.

Запрос к ресурсам, помеченным значком , доступен только зарегистрированным разработчикам. Ключ передаётся в строке запроса в формате — ?api_key=<ваш ключ>. API-Ключ можно посмотреть в настройках профиля.

Запрос к ресурсу /datasets возвращает список наборов данных.

Запрос:

Ответ:

Формат возвращаемого объекта

Ответ содержит массив элементов следующего формата:

• Id — Идентификатор набора данных
• CategoryId — Идентификатор тематической категории, которой соответствует набор данных
• DepartmentId — Идентификатор департамента, ответственного за набор данных
• Caption — Наименование набора данных

Запрос к ресурсу /datasets/{id} возвращает описание набора данных с указанием перечня атрибутов.

Запрос:

Ответ:

Формат возвращаемого объекта

Ответ содержит один элемент следующего формата:

• Id — Идентификатор набора данных
• CategoryId — Идентификатор тематической категории
• CategoryCaption — Наименование тематической категории
• DepartmentId — Идентификатор департамента, ответственного за набор данных
• DepartmentCaption — Наименование департамента
• Caption — Наименование набора данных
• Description — Краткое описание набора данных

Запрос к ресурсу /datasets/{id}/rows?versionNumber=V&releaseNumber=R возвращает список строк указанного набора данных. V - номер версии, R - номер релиза (versionNumber и releaseNumber необязательные параметры, по умолчанию возвращаются последние данные)

Запрос:

Ответ:

Формат возвращаемого объекта

Ответ содержит массив элементов следующего формата:

• Id — Идентификатор строки данных в формате GUID
• Number — Порядковый номер строки данных
• Cells — Объект, содержащий значения атрибутов для данной строки

Запрос к ресурсу /datasets/{id}/versions возвращает список версий указанного набора данных.

Запрос:

Ответ:

Формат возвращаемого объекта

Ответ содержит массив элементов следующего формата:

• version — Номер версии
• release — Номер релиза

Запрос к ресурсу /datasets/{id}/structure возвращает структуру указанного набора данных.

Запрос:

Ответ:

Формат возвращаемого объекта

Ответ содержит массив элементов следующего формата:

• Name — Идентификатор поля
• Caption — Название поля
• Visible — Видимость
• Type — Тип поля

Запрос к ресурсу /datasets/{id}/metadata возвращает метаданные указанного набора данных.

Запрос:

Ответ:

Формат возвращаемого объекта

Ответ содержит массив элементов следующего формата:

• Name — Наименование набора данных
• Description — Описание набора данных
• Owner — Владелец набора данных
• Resp_person — Ответственное лицо
• Phone_resp_person — Телефон ответственного лица
• Email_resp_person — Адрес электронной почты ответственного лица
• Category — Категория
• Period — Периодичность актуализации набора данных
• Keywords — Ключевые слова
• Publication — Метод публикации
• Territory — Территориальный разрез
• Retrospective — Глубина ретроспективы
• Status — Статус
• Start_date — Дата первой публикации
• End_date — Дата последней публикации
• Version — Версия набора