Приложение: Адресные типы данных
В методах, полезная нагрузка которых содержит в себе адресный объект, при интеграции можно выбрать тип передаваемых данных, согласно системе, используемой на стороне курьерской службы. Например для курьерских служб, работающих на территории РФ предпочтительно использовать информационную систему ГАР и ФИАС, ввиду высокой точности и обширности системы, однако там где нет возможности использовать вышеуказанные системы (например, для новых адресных объектов ещё не добавленных в реестр) - есть альтернативные способы предоставления информации: координатный и пользовательский. Сейчас предоставляется три типа адресных данных:
- ГАР и ФИАС (gar);
- передача местоположения осуществляется, в основном, с помощью идентификаторов ФИАС;
- Координатный (coord);
- передача местоположения осуществляется с помощью передачи координат, то есть широта и долгота в приоритете;
- Пользовательский (custom);
- передача местоположения осуществляется с помощью передачи частей адреса и полного стокового адреса, с дублированием координатами.
Таблицы детализации параметров различных типов адресных объектов представлены ниже:
ГАР и ФИАС
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| addressType | const: gar | 1 | Адресный объект типа ГАР и ФИАС | Заполняется: "gar" |
| fullAddress | string | 1 | Полный адрес в строковом формате | Например: "214014, г Смоленск, ул. Мира, д 7" |
| regionFias | string (36) UUID | 1 | Фиас-код региона (только для РФ) | Например: "ed36085a-b2f5-454f-b9a9-1c9a678ee618" |
| cityFias | string(36) UUID | 1 | Фиас-код города (только для РФ) | Например: "2763c110-cb8b-416a-9dac-ad28a55b4402" |
| houseFias | string(36) UUID | 1 | Фиас-код дома (только для РФ) | Например: "395bc31a-9fda-4804-a01b-13d79c15e3cb" |
| flat | string | 0 | Номер квартиры клиента | Необязательно, если адрес передаётся для ПВЗ |
| latitude | decimal | 0 | Широта объекта в десятичных градусах | 128-битный, с фиксированной точностью |
| longitude | decimal | 0 | Долгота объекта в десятичных градусах | 128-битный, с фиксированной точностью |
| addressComment | string (250) | 0 | Комментарий к адресу | Может совпадать с комментарием к ПВЗ |
Координатный
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| addressType | const: coord | 1 | Координатный адресный объект | Заполняется: "coord" |
| fullAddress | string | 1 | Полный адрес в строковом формате | Например: "214014, г Смоленск, ул. Мира, д 7" |
| cityFias | string(36) UUID | 0 | Фиас-код города (только для РФ) | Например: "2763c110-cb8b-416a-9dac-ad28a55b4402" |
| latitude | decimal | 1 | Широта объекта в десятичных градусах | 128-битный, с фиксированной точностью |
| longitude | decimal | 1 | Долгота объекта в десятичных градусах | 128-битный, с фиксированной точностью |
| flat | string | 0 | Номер квартиры клиента | Необязательно, если адрес передаётся для ПВЗ |
| addressComment | string (250) | 0 | Комментарий к адресу | Может совпадать с комментарием к ПВЗ |
Пользовательский
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| addressType | const: custom | 1 | Пользовательский адресный объект | Заполняется: "custom" |
| fullAddress | string | 1 | Полный адрес в строковом формате | Например: "214014, г Смоленск, ул. Мира, д 7" |
| countryCodeIso | string (2) | 0 | Код страны для адресного объекта | Согласно стандарту "ISO 3166-1, alpha-2" |
| regionCodeIso | string(6) | 0 | Код региона для адресного объекта | Согласно стандарту "ISO 3166-2" |
| regionName | string (100) | 1 | Название региона | Например: "Свердловская" |
| cityType | string (100) | 1 | Тип города | Например: "г" |
| cityName | string (100) | 1 | Название города | Например: "Екатеринбург" |
| localityType | string(30) | 0 | Тип населённого пункта назначения | Если это н.п. в составе другого города |
| localityName | string (100) | 0 | Наименование населённого пункта назначения | Например: "Кудрово", "Железнодорожный" |
| postalCode | string (6) | 0 | Почтовый индекс | Например: 620007 |
| streetType | string(30) | 0 | Тип улицы | Например: "Переулок", "Улица", "Проезд" |
| streetName | string (100) | 0 | Название улицы | Например: "Бобруйская", "Джона Леннона" |
| houseNumber | string(6) | 0 | Номер дома | Например: "42", "9", "3/4" |
| flat | string | 0 | Номер квартиры клиента | Необязательно, если адрес передаётся для ПВЗ |
| latitude | decimal | 0 | Широта объекта в десятичных градусах | 128-битный, с фиксированной точностью |
| longitude | decimal | 0 | Долгота объекта в десятичных градусах | 128-битный, с фиксированной точностью |
| nearestStation | string (100) | 0 | Ближайшая станция наземного транспорта | Например, "МГА", платформа "65км" e.t.c |
| nearestSubwayStation | string (100) | 0 | Ближайшая станция метро | Только для н.п., где есть метрополитен |
| addressComment | string (250) | 0 | Комментарий к адресу | Может совпадать с комментарием к ПВЗ |