library specs {🖫 271, ⚐ 17, ★ 0}

avtocod/specs

Specifications repository

Friday, July 27, 2018
by tarampampam
Repository
1 Watchers
0 Stars
271 Installations

PHP
0 Dependents
0 Suggesters
1 Forks
0 Open issues
17 Versions
421 % Grown

The README.md

avtocod , _(*1)

Публичные спецификации проекта "Автокод"

![Release date][badge_release_date] , _(*2)

Данный репозиторий содержит публичные спецификации, связанные с проектом "Автокод"., _(*3)

Поля данных отчёта (филды)

Поля данных (далее по тексту - филдлы) обладают следующими свойствами:, _(*4)

Филд имеет уникальный путь (path);
Пути (path) филдов являются фиксированными;
Имя филда данных состоит из букв латинского алфавита в нижнем регистре;
При необходимости разделить имя филда данных на составные слова используется символ "подчеркивания" (_);
Для группировки различных филдов используется нотация с помощью точки (.);
Глубина "вложенности" нотаций может быть произвольной;
Для указания того, что элемент пути филда является массивом используется обозначение [] (добавляется в конец группы филда).
Для указания типа данных, которые может содержать филд могут использоваться следующие ключевые слова - array, boolean, float, integer, object, string, null;
Каждый филд может быть null.

Пример нотации с помощью точки:, _(*5)

Имеется набор филдов: name, year, vin, owner_name. Все они относятся к базовым характеристикам ТС, кроме owner_name, который относится к данным владельца. В этом случае их именование будет иметь следующий вид: base.name, base.year, base.vin, owner.owner_name., _(*6)

Пример использования указателя массива:, _(*7)

Отчёт содержит набор данных о датах и местах прохождения технического осмотра ТС. Филды этих данных имеют вид diagnostic_card.items[].date и diagnostic_card.items[].place соответственно. Это означает, что diagnostic_card.items[] - это массив, элементами которого являются объекты, имеющие ключи date и place., _(*8)

Описание всех филдов вы можете найти в данном файле, json-schema отчёта располагается в этом файле., _(*9)

Примеры отчётов: с данными, без данных., _(*10)

Типы идентификаторов

Для создания отчёта необходимо передать тип и значение идентификатора (VIN-код, номер СТС и т.п.)., _(*11)

Поддерживаемые типы идентификаторов и их описания перечислены в данном файле., _(*12)

Имена источников

Для формирования данных отчёта происходят обращения к различным источникам. Каждый источник обладает следующими свойствами:, _(*13)

Имя источника состоит из букв латинского алфавита в нижнем регистре;
Для группировки различных источников используется нотация с помощью точки (.);
Каждый источник наполняет данными фиксированный набор филдов;
Если несколько источников наполняют данными одни и те же филды - в отчёт попадают данные от того источника, который нами считается наиболее доверительным.

Со всеми поддерживаемыми нами источниками вы можете ознакомиться в данном файле., _(*14)

Идентификаторы марок и моделей транспортных средств

Отчет может содержать данные о марках и моделях транспортных средств, включая их уникальные идентификаторы, состоящие из символов A-Z, цифр и символа _., _(*15)

Со всеми поддерживаемыми нами идентификаторами вы можете ознакомиться в файлах марок и моделей., _(*16)

Модели поделены по категориям типа ТС. Пример: models_bus.json - автобусы., _(*17)

С идентификаторами типов моделей вы можете ознакомится в файле спецификации., _(*18)

Обновления и версионирование

Данные, содержащиеся в данном репозитории обновляются с течением времени. Измененные состояния фиксируются с помощью тэгирования с присвоением соответствующего значения версии. Значения версий присваиваются в соответствии с правилами семантического версионирования., _(*19)

На данный момент существуют 3 мажорные версии:, _(*20)

v1 - устаревшая (не поддерживается с 22 июня 2018 года);
v2 - устаревшая (не поддерживается с 19 февраля 2019 года);
v3 - актуальная.

Для того, что бы получать уведомления об изменениях - подпишитесь на них, перейдя по этой ссылке., _(*21)

SDK

Список SDK для удобного доступа к данным спецификациям:, _(*22)

PHP avtocod/specs-php

Поддержка

Если у вас возникли какие-либо проблемы при работе с данным репозиторием, пожалуйста, создайте соответствующий issue перейдя по данной ссылке., _(*23)

The Versions

27/07 2018

dev-master

9999999-dev

Specifications repository

library specs

Specifications repository

avtocod/specs

The README.md

Публичные спецификации проекта "Автокод"

Поля данных отчёта (филды)

Типы идентификаторов

Имена источников

Идентификаторы марок и моделей транспортных средств

Обновления и версионирование

SDK

Поддержка

The Versions

dev-master

The Requires

The Development Requires

by Avtocod

v2.2.0

The Requires

The Development Requires

by Avtocod

v2.x-dev

The Requires

The Development Requires

by Avtocod

v2.1.0

The Requires

The Development Requires

by Avtocod

v2.0.0

The Requires

The Development Requires

by Avtocod

v1.x-dev

The Requires

The Development Requires

by Avtocod

v1.2.2

The Requires

The Development Requires

by Avtocod

dev-olyslager-source

The Requires

The Development Requires

by Avtocod

v1.2.1

The Requires

The Development Requires

by Avtocod

v1.2

The Requires

The Development Requires

by Avtocod

dev-add-mark-model-ids

The Requires

The Development Requires

by Avtocod

v1.1.2

The Requires

The Development Requires

by Avtocod

v1.1.1

The Requires

The Development Requires

by Avtocod

v1.1.0

The Requires

The Development Requires

by Avtocod

v1.0.1

by Avtocod

dev-CustomsHouseSpec

by Avtocod

v1.0.0

by Avtocod