Портал открытых данных «Открытый Краснодар»

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

Поддержка OData

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

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

Параметр	Тип	Описание
$top	integer	Ограничивает количество возвращаемых записей. По умолчанию выводятся все записи.
$skip	integer	Позволяет указать количество записей, которые следует пропустить в ответе. По умолчанию выводятся все записи.
$inlinecount	string	Может принимать значение allpages для того, чтобы в ответе получить общее количество записей. По умолчанию общее количество записей не выводится. Другие значения игнорируются.
$orderby	string	Указывает поле для сортировки результирующего списка. Пример: `?$orderby=title` или `?$orderby=id%20desc`

Версия API

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

GET https://opendata.krd.ru/api/

Ответ:

{
    "version": 1,
    "docs": "http://data.krd.ru/api/v1/docs/"
}

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

Список наборов данных

Запрос к ресурсу https://opendata.krd.ru/api/v1/datasets/ возвращает список наборов данных.

Пример:

https://opendata.krd.ru/api/v1/datasets/?$top=2$orderby=id&$inlinecount=allpages

Ответ:

{
    "count": 54,
    "items": [
        {
        "id": 7,
            "title": "Приемные депутатов",
            "name": "priemdeputatov",
            "subdivision": {
                "id": 1,
                "title": "Городская Дума"
            }
        },
        {
            "id": 8,
            "title": "Розничные рынки",
            "name": "roznichrynkov",
            "subdivision": {
                "id": 2,
                "title": "Управление торговли и бытового обслуживания"
            }
        }
    ]
}

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

id - Уникальный числовой идентификатор набора данных.
title - Наименование набора данных.
name - Уникальный символьный идентификатор набора данных.
subdivision - Департамент ответственный за набор данных.

id - Уникальный числовой идентификатор департамента.
title - Наименование департамента.

Паспорт набора данных

Запрос к ресурсу https://opendata.krd.ru/api/v1/datasets/{id} возвращает описание набора данных с указанием перечня полей.

Пример:

https://opendata.krd.ru/api/v1/datasets/7/

Ответ:

{
    "id": 7,
    "title": "Приемные депутатов",
    "name": "priemdeputatov",
    "description": "Приемные депутатов городской Думы Краснодара",
    "subdivision": {
        "id": 1,
        "title": "Городская Дума"
    },
    "tags": "Приемные депутатов",
    "fields": [
        {
            "title": "Приемная депутата",
            "name": "priemdeputata",
            "type": "string"
        },
        {
            "title": "Телефон приемной",
            "name": "telpriemnoy",
            "type": "phone"
        },
        {
            "title": "Адрес приемной",
            "name": "addrespriemnoy",
            "type": "address"
        },
        {
            "title": "График приема",
            "name": "grafikpriem",
            "type": "worktime"
        },
        {
            "title": "Яндекс.Карта",
            "name": "fymap",
            "type": "mappoint"
        },
        {
            "title": "Переадресация",
            "name": "pereadres",
            "type": "link"
        }
    ]
}

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

id - Уникальный числовой идентификатор набора данных.
title - Наименование набора данных.
name - Уникальный символьный идентификатор набора данных.
description - Описание набора данных.
subdivision - Департамент ответственный за набор данных.

id - Уникальный числовой идентификатор департамента.
title - Наименование департамента.

tags - Теги набора данных.
fields - Список полей набора данных

title - Заголовок поля.
name - Символьный идентификатор поля в пределах набора данных.
type - Тип поля.

Возможны следующие типы полей:

integer - Целое число.
string - Строка.
www - Ссылка на сайт в виде одного поля.
link - Ссылка. Поле представлено двумя отдельными полями с постфиксами:

_title - Заголовок ссылки.
_url - URL ссылки.

date - Дата без указания времени.
datetime - Дата и время.
worktime - Время работы. Содержит массив элементов со следующими полями:

day - День недели. 1-7 начиная с понедельника.
timestart - Время начала работы (hh:mm).
timeend - Время окончания работы (hh:mm).

address - Текстовое представление адреса. Поле представлено следующими отдельными полями с постфиксами (поля не являюятся обязательными и могут отсутствовать):

_district - Объект округа города. id - уникальный числовой идентификатор. title - наименование.
_region - Объект района города. id - уникальный числовой идентификатор. title - наименование.
_index - Почтовый индекс.
_city - Наименование населенного пункта.
_street - Наименование улицы населенного пункта.
_home - Номер дома.
_corp - Номер корпуса.
_room - Номер квартиры.
_office - Номер офиса.

phone - Массив телефонов.
email - Массив E-mail адресов.
text - Большое текстовое поле.
textarea - Текстовое поле, содержащее HTML разметку.
mappoint - Точка на карте. Объект со следующей структурой:

center - Массив с координатами рекомендуемого центра карты для показа объекта.
point - Массив с координатами самого объекта.
zoom - Рекомендуемый зум карты по Яндекс.Картам.

Содержимое набора данных

Запрос к ресурсу https://opendata.krd.ru/api/v1/datasets/{id}/rows возвращает список строк указанного набора данных.

Пример:

https://opendata.krd.ru/api/v1/datasets/7/rows/

Ответ:

[
    {
        "id": 2,
        "title": "Приемная депутата городской Думы Семёновой О.В.",
        "titlefull": "Приемная депутата городской Думы Семёновой О.В.",
        "sort": 10,
        "priemdeputata": "Семёновой О.В.",
        "telpriemnoy": [
            "+7-(778)-612-54-26"
        ],
        "addrespriemnoy_region": {
            "id": 100,
            "title": "Табачка"
        },
        "addrespriemnoy_index": "350042",
        "addrespriemnoy_city": "Краснодар",
        "addrespriemnoy_street": "Садовая",
        "addrespriemnoy_home": "222",
        "grafikpriem": [
            {
                "day": 1,
                "timestart": "14:00",
                "timeend": "16:00"
            }
        ],
        "fymap": {
            "center": [
                "45.05232801865243",
                "38.99789699999997"
            ],
            "point": [
                "45.052343229028125",
                "38.9979238220899"
            ],
            "zoom": "17"
        },
        "pereadres_title": "Информацию о деятельности депутата",
        "pereadres_url": "http://krd.ru/gorodskaya-duma/struktura-gorodskoy-dumy/
        deputaty-gorodskoy-dumy-krasnodara-v-sozyva/semenova.html"
    },
    {
        "id": 3,
        "title": "Приемная депутата городской Думы Красницкий А.В.",
        "titlefull": "Приемная депутата городской Думы Красницкий А.В.",
        "sort": 20,
        "priemdeputata": "Красницкий А.В.",
        "telpriemnoy": [
            "+7-(786)-122-23-66"
        ],
        "addrespriemnoy_region": {
            "id": 59,
            "title": "Авиагородок"
        },
        "addrespriemnoy_index": "350047",
        "addrespriemnoy_city": "Краснодар",
        "addrespriemnoy_street": "Толбухина",
        "addrespriemnoy_home": "87",
        "grafikpriem": [
        {
            "day": 4,
            "timestart": "14:00",
            "timeend": "16:00"
        }
        ],
        "fymap": {
            "center": [
                "45.066054518590285",
                "38.923488999999975"
            ],
            "point": [
                "45.06606212194052",
                "38.92358019510627"
            ],
            "zoom": "17"
        },
        "pereadres_title": "Информацию о деятельности депутата",
        "pereadres_url": "http://krd.ru/gorodskaya-duma/struktura-gorodskoy-dumy/
        deputaty-gorodskoy-dumy-krasnodara-v-sozyva/krasnickiy.html"
    }
]

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

id - Уникальный числовой идентификатор объекта в пределах набора данных.
title - Наименование объекта.
titlefull - Полное наименование объекта.
sort - Индекс сортировки.

Остальные поля зависят от полей набора данных.

Список районов города

Запрос к ресурсу https://opendata.krd.ru/api/v1/regions/ возвращает список районов города.

Пример:

https://opendata.krd.ru/api/v1/regions/

Ответ:

[
    {
        "id": 55,
        "title": "2-я Площадка"
    },
    {
        "id": 56,
        "title": "9 км"
    },
    {
        "id": 57,
        "title": "9-я Тихая"
    }
]

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

id - Уникальный цифровой идентификатор района.
title - Наименование района.

Список округов города

Запрос к ресурсу https://opendata.krd.ru/api/v1/districts/ возвращает список округов города.

Пример:

https://opendata.krd.ru/api/v1/districts/

Ответ:

[
    {
        "id": 1,
        "title": "Западный Округ"
    },
    {
        "id": 2,
        "title": "Центральный Округ"
    },
    {
        "id": 3,
        "title": "Прикубанский Округ"
    },
    {
        "id": 4,
        "title": "Карасунский Округ"
    }
]

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

id - Уникальный цифровой идентификатор округа.
title - Наименование округа.