Верховна Рада України
Портал відкритих даних

Паспорт відкритих даних

Для ідентифікації та обробки інформації набору потрібен паспорт відкритих даних – об’єкт meta в реєстрі відкритих даних та файл з відповідним ім’ям. Як і реєстр, він повинен включати заголовок та набір елементів item, що містять дані з відповідними типами: дані структури (stru), версії набору (data) та інші (опис – info, програмний код – code, доступ до веб-сервісів – api тощо):

id – внутрішній ідентифікатор даних (рядок або код);
guid – глобальний ідентифікаційний номер даних (URN);
title – назва набору відкритих даних (рядок до 254 символів);
link – адреса сторінки в Інтернет – аналогу відкритих даних для людини (URL);
description – необов’язковий опис набора даних (текст до 4000 символів);
language – мова документу по замовчанню;
pubDate – дата та час публікації файлу;
lastBuildData – дата та час останнього формування даних;
path – шлях до файлів (від кореневого каталога сервера без імені файлу);
format – формати, в яких доступний паспорт (один чи декілька: XML, JSON, CSV…);
publisher – розпорядник інформації, який публікує набори даних;
creator – назва підрозділу, який безпосередньо створює та наповнює інформацію;
manager – адреса чи прізвище відповідального працівника підрозділу creator;
managerPhone – необов’язковий телефонний номер відповідального працівника;
webMaster – адреса технічного працівника, який формує набори відкритих даних;
opendata – адреса порталу відкритих даних, з якого взята інформація;
category – необов’язкова назва категорії відкритих даних (ідентифікатор або посилання);
keywords – необов’язкові ключові слова (через кому).

Для кожного елементу (файлу або сервісу) передбачені наступні параметри:

id – внутрішній ідентифікатор даних (рядок або код);
guid – глобальний ідентифікаційний номер даних (URN);
type – тип елементу відкритих даних: stru - структура, data - дані, info - інформація, code - приклади коду, api – веб-сервіс;
title – назва об’єкту вказаного типу type (рядок до 254 символів);
link – адреса сторінки в Інтернет (URL);
description – необов’язковий опис об’єкту (текст до 4000 символів);
pubDate – дата та час публікації файлу;
filename – повна назва файлу (разом зі шляхом), якщо відрізняється від стандартної;
path – необов’язковий шлях до файлу, якщо відрізняється від поточного;
name – назва файлу, якщо відрізняється від type;
format – формати, в яких доступні метадані (один чи декілька: XML, JSON, CSV…);
structure – ідентифікатор структури даних, якщо вона відрізняється від поточної;
version – необов’язковий номер версії файлу;
size – необов’язковий розмір файлу даних (в байтах);
checksum – необов’язкова чексума для контролю правильності отримання файлу (MD5);
archived – ознака, якщо файл заархівований (містить тип архіватора, наприклад zip);
orderby - порядок сортування даних (якщо є, то вказуються назви полів через кому).

Якщо файли даних чи структури мають декілька версій за різні дати, то назви цих файлів, крім останніх версій, повинні включати суфікс – дату pubDate в форматі YYYYMMDD або інший унікальний атрибут, наприклад version. Коли файл даних великий (size >= 250000), для зручності передачі в Інтернет, його можна додатково архівувати. Для цього використовується ознака archived, яка містить тип архіватора, наприклад zip.

Схема паспорту відкритих даних у форматі XSD:

<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<xsd:element name="meta" type="metaType"/>
	
	<xsd:complexType name="metaType">
		<xsd:annotation>
			<xsd:documentation xml:lang="en">Opendata meta</xsd:documentation>
			<xsd:documentation xml:lang="uk">Паспорт відкритих даних.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="id" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata identification number</xsd:documentation>
					<xsd:documentation xml:lang="uk">Внутрішній ідентифікатор даних (рядок або код).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="guid" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Global universal identification number</xsd:documentation>
					<xsd:documentation xml:lang="uk">Глобальний ідентифікаційний номер даних (URN).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="title" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata title</xsd:documentation>
					<xsd:documentation xml:lang="uk">Назва набору відкритих даних (рядок до 254 символів).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="link" type="xsd:anyURI" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata URL</xsd:documentation>
					<xsd:documentation xml:lang="uk">Адреса сторінки в Інтернет – аналогу відкритих даних для людини (URL).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="description" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata description</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язковий опис набору відкритих даних (текст до 4000 символів).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="language" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Default language</xsd:documentation>
					<xsd:documentation xml:lang="uk">Мова документу по замовчанню.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="pubDate" type="xsd:dateTime">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Publication date and time</xsd:documentation>
					<xsd:documentation xml:lang="uk">Дата та час публікації файлу.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="lastBuildDate" type="xsd:dateTime">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Last build date and time</xsd:documentation>
					<xsd:documentation xml:lang="uk">Дата та час останнього формування даних.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="path" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Path to opendata</xsd:documentation>
					<xsd:documentation xml:lang="uk">Шлях до файлів відкритих даних (від кореневого каталога сервера без імені файлу).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="format" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Formats of opendata</xsd:documentation>
					<xsd:documentation xml:lang="uk">Формати, в яких доступний паспорт (один чи декілька: XML, JSON, CSV… через кому).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="publisher" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Publisher of opendata</xsd:documentation>
					<xsd:documentation xml:lang="uk">Розпорядник інформації, який публікує набори даних.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="creator" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Creator of opendata</xsd:documentation>
					<xsd:documentation xml:lang="uk">Назва підрозділу, який безпосередньо створює та наповнює інформацію.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="manager" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Manager of opendata</xsd:documentation>
					<xsd:documentation xml:lang="uk">Aдреса чи прізвище відповідального працівника підрозділу creator.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="managerPhone" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Manager's phone number</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язковий телефонний номер відповідального працівника.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="webMaster" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Webmaster's e-mail</xsd:documentation>
					<xsd:documentation xml:lang="uk">Адреса технічного працівника, який формує набори відкритих даних.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="opendata" type="xsd:anyURI" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata Hub URL</xsd:documentation>
					<xsd:documentation xml:lang="uk">Адреса порталу відкритих даних, з якого взята інформація.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="category" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata category</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язкова назва категорії відкритих даних (ідентифікатор або посилання).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="keywords" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata keywords</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язкові ключові слова (через кому).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="item" type="itemType" maxOccurs="unbounded"/>
		</xsd:sequence>
	</xsd:complexType>
	
	<xsd:complexType name="itemType">
		<xsd:annotation>
			<xsd:documentation xml:lang="en">Opendata list item</xsd:documentation>
			<xsd:documentation xml:lang="uk">Елемент реєстру відкритих даних.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="id" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata identification number</xsd:documentation>
					<xsd:documentation xml:lang="uk">Внутрішній ідентифікатор даних (рядок або код).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="guid" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Global universal identification number</xsd:documentation>
					<xsd:documentation xml:lang="uk">Глобальний ідентифікаційний номер даних (URN).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="title" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata title</xsd:documentation>
					<xsd:documentation xml:lang="uk">Назва об'єкту вказаного типу type (рядок до 254 символів).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="link" type="xsd:anyURI" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata URL</xsd:documentation>
					<xsd:documentation xml:lang="uk">Адреса сторінки в Інтернет (URL).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="description" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Opendata description</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язковий опис об'єкту (текст до 4000 символів).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="pubDate" type="xsd:dateTime">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Publication date and time</xsd:documentation>
					<xsd:documentation xml:lang="uk">Дата та час публікації файлу.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="filename" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Full path to opendata file</xsd:documentation>
					<xsd:documentation xml:lang="uk">Повна назва файлу (разом зі шляхом), якщо відрізняється від стандартної.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="path" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Path to opendata file</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язковий шлях до файлу, якщо відрізняється від поточного.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="name" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Name of opendata file</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язкова назва файлу, якщо відрізняється від type-pubDate.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="format" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Formats of opendata</xsd:documentation>
					<xsd:documentation xml:lang="uk">Формат файлу (один чи декілька: XML, JSON, CSV… через кому).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="structure" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Structure of opendata</xsd:documentation>
					<xsd:documentation xml:lang="uk">Ідентифікатор структури даних, якщо вона відрізняється від поточної.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="version" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Version of opendata file</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язковий номер версії файлу.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="size" type="xsd:integer" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Size of opendata file (bytes)</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язковий розмір файлу даних (в байтах).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="checksum" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Checksum of opendata file (md5)</xsd:documentation>
					<xsd:documentation xml:lang="uk">Необов’язкова чексума для контролю правильності отримання файлу (MD5).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="archived" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Type of archived opendata file</xsd:documentation>
					<xsd:documentation xml:lang="uk">Ознака, якщо файл заархівований (містить тип архіватора, наприклад zip).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="orderby" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation xml:lang="en">Order of opendata file</xsd:documentation>
					<xsd:documentation xml:lang="uk">Порядок сортування даних (якщо є, вказуються назви полів через кому).</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
		</xsd:sequence>
		<xsd:attribute name="type">
			<xsd:annotation>
				<xsd:documentation xml:lang="en">Type of opendata</xsd:documentation>
				<xsd:documentation xml:lang="uk">Тип відкритих даних (stru - структура, data - дані, info - інформація, code - приклади коду, api - сервіс онлайн).</xsd:documentation>
			</xsd:annotation>
			<xsd:simpleType>
				<xsd:restriction base="xs:string">
					<xsd:pattern value="stru|data|info|code|api"/>
				</xsd:restriction>
			</xsd:simpleType>
		</xsd:attribute>
	</xsd:complexType>
</xsd:schema>


вгору