2017 © Pedro Peláez
 

library specs

Specifications repository

image

avtocod/specs

Specifications repository

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

The README.md

avtocod, (*1)

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

Release version ![Release date][badge_release_date] Commits since latest release, (*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)

Поддержка

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

The Versions

27/07 2018

dev-master

9999999-dev

Specifications repository

  Sources   Download

MIT

The Requires

 

The Development Requires

specs specifications avtocod

27/07 2018

v2.2.0

2.2.0.0

Specifications repository

  Sources   Download

MIT

The Requires

 

The Development Requires

specs specifications avtocod

27/07 2018

v2.x-dev

2.9999999.9999999.9999999-dev

Specifications repository

  Sources   Download

MIT

The Requires

 

The Development Requires

specs specifications avtocod

26/07 2018

v2.1.0

2.1.0.0

Specifications repository

  Sources   Download

MIT

The Requires

 

The Development Requires

specs specifications avtocod

16/06 2018

v2.0.0

2.0.0.0

Specifications repository

  Sources   Download

MIT

The Requires

 

The Development Requires

specs specifications avtocod

16/06 2018

v1.x-dev

1.9999999.9999999.9999999-dev

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

16/06 2018

v1.2.2

1.2.2.0

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

15/05 2018

dev-olyslager-source

dev-olyslager-source

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

04/05 2018

v1.2.1

1.2.1.0

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

05/04 2018

v1.2

1.2.0.0

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

20/03 2018

dev-add-mark-model-ids

dev-add-mark-model-ids

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

19/02 2018

v1.1.2

1.1.2.0

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

17/01 2018

v1.1.1

1.1.1.0

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

17/01 2018

v1.1.0

1.1.0.0

Specifications repository

  Sources   Download

MIT

The Requires

  • php ^5.6 || >=7.0 <=7.3

 

The Development Requires

specs specifications avtocod

17/01 2018

v1.0.1

1.0.1.0

Specifications repository

  Sources   Download

MIT

specs specifications avtocod

17/01 2018

dev-CustomsHouseSpec

dev-CustomsHouseSpec

Specifications repository

  Sources   Download

MIT

specs specifications avtocod

30/11 2017

v1.0.0

1.0.0.0

Specifications repository

  Sources   Download

MIT

specs specifications avtocod