Автопарк и водители

Методы для работы с автопарком

Версия

Получение транспортных средств пользователя

get /v1.2/catalogs/trucks

Модель и примеры
Консоль

Параметры

Параметров нет

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/trucks' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.2/catalogs/trucks");

Ответ

200 Список транспортных средств

Модель

[{...}]

truck_info_id: guid

Id транспортного средства

related_id: guid (nullable)

Id связанного транспортного средства

is_attracted_truck: boolean

Привлеченное ТС. Устарело, используйте ownership_type

deprecated

ownership_type:

Тип владения ТС

* 0 - Собственное
* 1 - Привлеченное
* 2 - Аренда
* 3 - Лизинг
* 4 - Совместная собственность супругов
* 5 - Безвозмездное пользование

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

type:

Тип транспортного средства

* 1 — Грузовик
* 2 — Тягач
* 4 — Полуприцеп
* 8 — Прицеп

ONE-OF

enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

description: string

Короткое описание

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

last_deal_related_id: guid (nullable)

Id связанного во время последней сделки транспортного средства

manufacture_year: int32 (nullable)

Год выпуска

hidden_in_firm_info: boolean

Не отображать в карточке фирмы

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

external_id: string

Идентификатор

scans:[{...}]

Сканы документов ТС

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[3, 4, 6, 7, 8]

Тип документа

3 — Скан ПТС
4 — Скан пластикового ПТС
6 — Скан договора аренеды
7 — Скан свидетельства о браке
8 — Скан договора безвозмездного пользования

}]

photos:[{...}]

Фото ТС

owner_id: guid

id: guid

Id фото

file_id: string

path: string

Адрес расположения файла в хранилище

Имя файла

}]

sensors:[{...}]

Датчики мониторинга транспорта

sensor_id: int32

Идентификатор датчика

sensor_name: string

Наименование датчика

provider_id: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

is_active: boolean

Статус активности датчика

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url: string

Адрес сервера

}

}]

Пример

[...]

{...}

"truck_info_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ownership_type":0,

"type":0,

"car_type_id":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"manufacture_year":0,

"hidden_in_firm_info":false,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"external_id":"string",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"photos":[...],

{...}

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"file_id":"string",

"path":"string",

"name":"string"

}

"sensors":[...]

{...}

"sensor_id":0,

"sensor_name":"string",

"provider_id":0,

"provider_sensor_id":"string",

"is_active":false,

"unactivate_date":"1970-01-01T00:00:00.000Z",

"host":{...}

"sensor_host_id":0,

"url":"string"

}

]

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Получение транспортных средств пользователя

get /gw/oauth2/catalogs/v1.2/trucks

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметров нет

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/trucks' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/trucks");

Ответ

200 Список транспортных средств

Модель

[{...}]

truck_info_id: guid

Id транспортного средства

related_id: guid (nullable)

Id связанного транспортного средства

is_attracted_truck: boolean

Привлеченное ТС. Устарело, используйте ownership_type

deprecated

ownership_type:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

type:

Тип транспортного средства

* 1 — Грузовик
* 2 — Тягач
* 4 — Полуприцеп
* 8 — Прицеп

ONE-OF

enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

description: string

Короткое описание

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

last_deal_related_id: guid (nullable)

Id связанного во время последней сделки транспортного средства

manufacture_year: int32 (nullable)

Год выпуска

hidden_in_firm_info: boolean

Не отображать в карточке фирмы

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

external_id: string

Идентификатор

scans:[{...}]

Сканы документов ТС

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[3, 4, 6, 7, 8]

Тип документа

3 — Скан ПТС
4 — Скан пластикового ПТС
6 — Скан договора аренеды
7 — Скан свидетельства о браке
8 — Скан договора безвозмездного пользования

}]

photos:[{...}]

Фото ТС

owner_id: guid

id: guid

Id фото

file_id: string

path: string

Адрес расположения файла в хранилище

Имя файла

}]

sensors:[{...}]

Датчики мониторинга транспорта

sensor_id: int32

Идентификатор датчика

sensor_name: string

Наименование датчика

provider_id: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

is_active: boolean

Статус активности датчика

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url: string

Адрес сервера

}

}]

Пример

[...]

{...}

"truck_info_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ownership_type":0,

"type":0,

"car_type_id":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"manufacture_year":0,

"hidden_in_firm_info":false,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"external_id":"string",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"photos":[...],

{...}

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"file_id":"string",

"path":"string",

"name":"string"

}

"sensors":[...]

{...}

"sensor_id":0,

"sensor_name":"string",

"provider_id":0,

"provider_sensor_id":"string",

"is_active":false,

"unactivate_date":"1970-01-01T00:00:00.000Z",

"host":{...}

"sensor_host_id":0,

"url":"string"

}

]

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Версия

Создание транспортного средства

post /v1.2/catalogs/trucks

Модель и примеры
Консоль

Параметры

Параметров нет

Запрос

Модель

{...}

type: enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

manufacture_year: int32 (nullable)

Год выпуска

ownership_type:

Тип владения ТС.<br>
* 0 - Собственное
* 1 - Привлеченное
* 2 - Аренда
* 3 - Лизинг
* 4 - Совместная собственность супругов
* 5 - Безвозмездное пользование

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

phone_number: string

Номер телефона

bind_phone: boolean (nullable)

Эксклюзивный доступ к приложению Ати-Водитель

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

hidden_in_firm_info: boolean

Не отображать в карточке фирмы.

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

truck_passport_number: string

Номер ПТС

external_id: string

Идентификатор

sensors:[{...}]

Датчики мониторинга

sensor_id: int32

Идентификатор датчика

sensor_name*: string

Минимальное количество символов: 1

Наименование датчика

provider_id*: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host*:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url*: string

Минимальное количество символов: 1

Адрес сервера

}

}]

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/trucks' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"type":0,"car_type_id":0,"brand_id":0,"model":"string","number":"string","manufacture_year":0,"ownership_type":0,"phone_number":"string","bind_phone":false,"capacity":0.5,"volume":0.5,"length":0.5,"width":0.5,"height":0.5,"hidden_in_firm_info":false,"vin":"string","vrc":"string","body_number":"string","can_refrigerator":false,"has_gen_set":false,"dimension":0,"truck_owner_name":"string","can_carry_heavy_container":false,"can_carry_tall_container":false,"truck_passport_number":"string","external_id":"string","sensors":[{"sensor_id":0,"sensor_name":"string","provider_id":0,"provider_sensor_id":"string","unactivate_date":"1970-01-01T00:00:00.000Z","host":{"sensor_host_id":0,"url":"string"}}]}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1.2/catalogs/trucks", "{""type"":0,""car_type_id"":0,""brand_id"":0,""model"":""string"",""number"":""string"",""manufacture_year"":0,""ownership_type"":0,""phone_number"":""string"",""bind_phone"":false,""capacity"":0.5,""volume"":0.5,""length"":0.5,""width"":0.5,""height"":0.5,""hidden_in_firm_info"":false,""vin"":""string"",""vrc"":""string"",""body_number"":""string"",""can_refrigerator"":false,""has_gen_set"":false,""dimension"":0,""truck_owner_name"":""string"",""can_carry_heavy_container"":false,""can_carry_tall_container"":false,""truck_passport_number"":""string"",""external_id"":""string"",""sensors"":[{""sensor_id"":0,""sensor_name"":""string"",""provider_id"":0,""provider_sensor_id"":""string"",""unactivate_date"":""1970-01-01T00:00:00.000Z"",""host"":{""sensor_host_id"":0,""url"":""string""}}]}");

Ответ

200 Созданное транспортное средство

Модель

{...}

truck_info_id: guid

Id транспортного средства

related_id: guid (nullable)

Id связанного транспортного средства

is_attracted_truck: boolean

Привлеченное ТС. Устарело, используйте ownership_type

deprecated

ownership_type:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

type:

Тип транспортного средства

* 1 — Грузовик
* 2 — Тягач
* 4 — Полуприцеп
* 8 — Прицеп

ONE-OF

enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

description: string

Короткое описание

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

last_deal_related_id: guid (nullable)

Id связанного во время последней сделки транспортного средства

manufacture_year: int32 (nullable)

Год выпуска

hidden_in_firm_info: boolean

Не отображать в карточке фирмы

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

external_id: string

Идентификатор

scans:[{...}]

Сканы документов ТС

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[3, 4, 6, 7, 8]

Тип документа

3 — Скан ПТС
4 — Скан пластикового ПТС
6 — Скан договора аренеды
7 — Скан свидетельства о браке
8 — Скан договора безвозмездного пользования

}]

photos:[{...}]

Фото ТС

owner_id: guid

id: guid

Id фото

file_id: string

path: string

Адрес расположения файла в хранилище

Имя файла

}]

sensors:[{...}]

Датчики мониторинга транспорта

sensor_id: int32

Идентификатор датчика

sensor_name: string

Наименование датчика

provider_id: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

is_active: boolean

Статус активности датчика

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url: string

Адрес сервера

}

}]

}

Пример

{...}

"truck_info_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ownership_type":0,

"type":0,

"car_type_id":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"manufacture_year":0,

"hidden_in_firm_info":false,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"external_id":"string",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"photos":[...],

{...}

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"file_id":"string",

"path":"string",

"name":"string"

}

"sensors":[...]

{...}

"sensor_id":0,

"sensor_name":"string",

"provider_id":0,

"provider_sensor_id":"string",

"is_active":false,

"unactivate_date":"1970-01-01T00:00:00.000Z",

"host":{...}

"sensor_host_id":0,

"url":"string"

}

]

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Создание транспортного средства

post /gw/oauth2/catalogs/v1.2/trucks

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметров нет

Запрос

Модель

{...}

type: enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

manufacture_year: int32 (nullable)

Год выпуска

ownership_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

phone_number: string

Номер телефона

bind_phone: boolean (nullable)

Эксклюзивный доступ к приложению Ати-Водитель

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

hidden_in_firm_info: boolean

Не отображать в карточке фирмы.

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

truck_passport_number: string

Номер ПТС

external_id: string

Идентификатор

sensors:[{...}]

Датчики мониторинга

sensor_id: int32

Идентификатор датчика

sensor_name*: string

Минимальное количество символов: 1

Наименование датчика

provider_id*: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host*:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url*: string

Минимальное количество символов: 1

Адрес сервера

}

}]

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/trucks' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"type":0,"car_type_id":0,"brand_id":0,"model":"string","number":"string","manufacture_year":0,"ownership_type":0,"phone_number":"string","bind_phone":false,"capacity":0.5,"volume":0.5,"length":0.5,"width":0.5,"height":0.5,"hidden_in_firm_info":false,"vin":"string","vrc":"string","body_number":"string","can_refrigerator":false,"has_gen_set":false,"dimension":0,"truck_owner_name":"string","can_carry_heavy_container":false,"can_carry_tall_container":false,"truck_passport_number":"string","external_id":"string","sensors":[{"sensor_id":0,"sensor_name":"string","provider_id":0,"provider_sensor_id":"string","unactivate_date":"1970-01-01T00:00:00.000Z","host":{"sensor_host_id":0,"url":"string"}}]}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/trucks", "{""type"":0,""car_type_id"":0,""brand_id"":0,""model"":""string"",""number"":""string"",""manufacture_year"":0,""ownership_type"":0,""phone_number"":""string"",""bind_phone"":false,""capacity"":0.5,""volume"":0.5,""length"":0.5,""width"":0.5,""height"":0.5,""hidden_in_firm_info"":false,""vin"":""string"",""vrc"":""string"",""body_number"":""string"",""can_refrigerator"":false,""has_gen_set"":false,""dimension"":0,""truck_owner_name"":""string"",""can_carry_heavy_container"":false,""can_carry_tall_container"":false,""truck_passport_number"":""string"",""external_id"":""string"",""sensors"":[{""sensor_id"":0,""sensor_name"":""string"",""provider_id"":0,""provider_sensor_id"":""string"",""unactivate_date"":""1970-01-01T00:00:00.000Z"",""host"":{""sensor_host_id"":0,""url"":""string""}}]}");

Ответ

200 Созданное транспортное средство

Модель

{...}

truck_info_id: guid

Id транспортного средства

related_id: guid (nullable)

Id связанного транспортного средства

is_attracted_truck: boolean

Привлеченное ТС. Устарело, используйте ownership_type

deprecated

ownership_type:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

type:

Тип транспортного средства

* 1 — Грузовик
* 2 — Тягач
* 4 — Полуприцеп
* 8 — Прицеп

ONE-OF

enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

description: string

Короткое описание

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

last_deal_related_id: guid (nullable)

Id связанного во время последней сделки транспортного средства

manufacture_year: int32 (nullable)

Год выпуска

hidden_in_firm_info: boolean

Не отображать в карточке фирмы

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

external_id: string

Идентификатор

scans:[{...}]

Сканы документов ТС

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[3, 4, 6, 7, 8]

Тип документа

3 — Скан ПТС
4 — Скан пластикового ПТС
6 — Скан договора аренеды
7 — Скан свидетельства о браке
8 — Скан договора безвозмездного пользования

}]

photos:[{...}]

Фото ТС

owner_id: guid

id: guid

Id фото

file_id: string

path: string

Адрес расположения файла в хранилище

Имя файла

}]

sensors:[{...}]

Датчики мониторинга транспорта

sensor_id: int32

Идентификатор датчика

sensor_name: string

Наименование датчика

provider_id: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

is_active: boolean

Статус активности датчика

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url: string

Адрес сервера

}

}]

}

Пример

{...}

"truck_info_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ownership_type":0,

"type":0,

"car_type_id":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"manufacture_year":0,

"hidden_in_firm_info":false,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"external_id":"string",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"photos":[...],

{...}

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"file_id":"string",

"path":"string",

"name":"string"

}

"sensors":[...]

{...}

"sensor_id":0,

"sensor_name":"string",

"provider_id":0,

"provider_sensor_id":"string",

"is_active":false,

"unactivate_date":"1970-01-01T00:00:00.000Z",

"host":{...}

"sensor_host_id":0,

"url":"string"

}

]

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Версия

Получение транспортного средства пользователя

get /v1.2/catalogs/trucks/{truckId}

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`truckId` обязательный	string (guid)	`path`	Id транспотрного средства Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/trucks/{truckId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.2/catalogs/trucks/{truckId}");

Ответ

200 Транспортное средство

Модель

{...}

truck_info_id: guid

Id транспортного средства

related_id: guid (nullable)

Id связанного транспортного средства

is_attracted_truck: boolean

Привлеченное ТС. Устарело, используйте ownership_type

deprecated

ownership_type:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

type:

Тип транспортного средства

* 1 — Грузовик
* 2 — Тягач
* 4 — Полуприцеп
* 8 — Прицеп

ONE-OF

enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

description: string

Короткое описание

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

last_deal_related_id: guid (nullable)

Id связанного во время последней сделки транспортного средства

manufacture_year: int32 (nullable)

Год выпуска

hidden_in_firm_info: boolean

Не отображать в карточке фирмы

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

external_id: string

Идентификатор

scans:[{...}]

Сканы документов ТС

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[3, 4, 6, 7, 8]

Тип документа

3 — Скан ПТС
4 — Скан пластикового ПТС
6 — Скан договора аренеды
7 — Скан свидетельства о браке
8 — Скан договора безвозмездного пользования

}]

photos:[{...}]

Фото ТС

owner_id: guid

id: guid

Id фото

file_id: string

path: string

Адрес расположения файла в хранилище

Имя файла

}]

sensors:[{...}]

Датчики мониторинга транспорта

sensor_id: int32

Идентификатор датчика

sensor_name: string

Наименование датчика

provider_id: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

is_active: boolean

Статус активности датчика

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url: string

Адрес сервера

}

}]

}

Пример

{...}

"truck_info_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ownership_type":0,

"type":0,

"car_type_id":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"manufacture_year":0,

"hidden_in_firm_info":false,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"external_id":"string",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"photos":[...],

{...}

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"file_id":"string",

"path":"string",

"name":"string"

}

"sensors":[...]

{...}

"sensor_id":0,

"sensor_name":"string",

"provider_id":0,

"provider_sensor_id":"string",

"is_active":false,

"unactivate_date":"1970-01-01T00:00:00.000Z",

"host":{...}

"sensor_host_id":0,

"url":"string"

}

]

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Получение транспортного средства пользователя

get /gw/oauth2/catalogs/v1.2/trucks/{truckId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`truckId` обязательный	string (guid)	`path`	Id транспотрного средства Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/trucks/{truckId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/trucks/{truckId}");

Ответ

200 Транспортное средство

Модель

{...}

truck_info_id: guid

Id транспортного средства

related_id: guid (nullable)

Id связанного транспортного средства

is_attracted_truck: boolean

Привлеченное ТС. Устарело, используйте ownership_type

deprecated

ownership_type:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

type:

Тип транспортного средства

* 1 — Грузовик
* 2 — Тягач
* 4 — Полуприцеп
* 8 — Прицеп

ONE-OF

enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

description: string

Короткое описание

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

last_deal_related_id: guid (nullable)

Id связанного во время последней сделки транспортного средства

manufacture_year: int32 (nullable)

Год выпуска

hidden_in_firm_info: boolean

Не отображать в карточке фирмы

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

external_id: string

Идентификатор

scans:[{...}]

Сканы документов ТС

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[3, 4, 6, 7, 8]

Тип документа

3 — Скан ПТС
4 — Скан пластикового ПТС
6 — Скан договора аренеды
7 — Скан свидетельства о браке
8 — Скан договора безвозмездного пользования

}]

photos:[{...}]

Фото ТС

owner_id: guid

id: guid

Id фото

file_id: string

path: string

Адрес расположения файла в хранилище

Имя файла

}]

sensors:[{...}]

Датчики мониторинга транспорта

sensor_id: int32

Идентификатор датчика

sensor_name: string

Наименование датчика

provider_id: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

is_active: boolean

Статус активности датчика

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url: string

Адрес сервера

}

}]

}

Пример

{...}

"truck_info_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ownership_type":0,

"type":0,

"car_type_id":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"manufacture_year":0,

"hidden_in_firm_info":false,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"external_id":"string",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"photos":[...],

{...}

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"file_id":"string",

"path":"string",

"name":"string"

}

"sensors":[...]

{...}

"sensor_id":0,

"sensor_name":"string",

"provider_id":0,

"provider_sensor_id":"string",

"is_active":false,

"unactivate_date":"1970-01-01T00:00:00.000Z",

"host":{...}

"sensor_host_id":0,

"url":"string"

}

]

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Версия

Редактирование транспортного средства

put /v1.2/catalogs/trucks/{truckId}

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`truckId` обязательный	string (guid)	`path`	Id транспортного средства Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Модель

{...}

type: enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

manufacture_year: int32 (nullable)

Год выпуска

ownership_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

phone_number: string

Номер телефона

bind_phone: boolean (nullable)

Эксклюзивный доступ к приложению Ати-Водитель

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

hidden_in_firm_info: boolean

Не отображать в карточке фирмы.

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

truck_passport_number: string

Номер ПТС

external_id: string

Идентификатор

sensors:[{...}]

Датчики мониторинга

sensor_id: int32

Идентификатор датчика

sensor_name*: string

Минимальное количество символов: 1

Наименование датчика

provider_id*: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host*:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url*: string

Минимальное количество символов: 1

Адрес сервера

}

}]

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/trucks/{truckId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"type":0,"car_type_id":0,"brand_id":0,"model":"string","number":"string","manufacture_year":0,"ownership_type":0,"phone_number":"string","bind_phone":false,"capacity":0.5,"volume":0.5,"length":0.5,"width":0.5,"height":0.5,"hidden_in_firm_info":false,"vin":"string","vrc":"string","body_number":"string","can_refrigerator":false,"has_gen_set":false,"dimension":0,"truck_owner_name":"string","can_carry_heavy_container":false,"can_carry_tall_container":false,"truck_passport_number":"string","external_id":"string","sensors":[{"sensor_id":0,"sensor_name":"string","provider_id":0,"provider_sensor_id":"string","unactivate_date":"1970-01-01T00:00:00.000Z","host":{"sensor_host_id":0,"url":"string"}}]}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.2/catalogs/trucks/{truckId}", "{""type"":0,""car_type_id"":0,""brand_id"":0,""model"":""string"",""number"":""string"",""manufacture_year"":0,""ownership_type"":0,""phone_number"":""string"",""bind_phone"":false,""capacity"":0.5,""volume"":0.5,""length"":0.5,""width"":0.5,""height"":0.5,""hidden_in_firm_info"":false,""vin"":""string"",""vrc"":""string"",""body_number"":""string"",""can_refrigerator"":false,""has_gen_set"":false,""dimension"":0,""truck_owner_name"":""string"",""can_carry_heavy_container"":false,""can_carry_tall_container"":false,""truck_passport_number"":""string"",""external_id"":""string"",""sensors"":[{""sensor_id"":0,""sensor_name"":""string"",""provider_id"":0,""provider_sensor_id"":""string"",""unactivate_date"":""1970-01-01T00:00:00.000Z"",""host"":{""sensor_host_id"":0,""url"":""string""}}]}");

Ответ

200 Отредактированное транспортное средство

Модель

{...}

truck_info_id: guid

Id транспортного средства

related_id: guid (nullable)

Id связанного транспортного средства

is_attracted_truck: boolean

Привлеченное ТС. Устарело, используйте ownership_type

deprecated

ownership_type:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

type:

Тип транспортного средства

* 1 — Грузовик
* 2 — Тягач
* 4 — Полуприцеп
* 8 — Прицеп

ONE-OF

enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

description: string

Короткое описание

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

last_deal_related_id: guid (nullable)

Id связанного во время последней сделки транспортного средства

manufacture_year: int32 (nullable)

Год выпуска

hidden_in_firm_info: boolean

Не отображать в карточке фирмы

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

external_id: string

Идентификатор

scans:[{...}]

Сканы документов ТС

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[3, 4, 6, 7, 8]

Тип документа

3 — Скан ПТС
4 — Скан пластикового ПТС
6 — Скан договора аренеды
7 — Скан свидетельства о браке
8 — Скан договора безвозмездного пользования

}]

photos:[{...}]

Фото ТС

owner_id: guid

id: guid

Id фото

file_id: string

path: string

Адрес расположения файла в хранилище

Имя файла

}]

sensors:[{...}]

Датчики мониторинга транспорта

sensor_id: int32

Идентификатор датчика

sensor_name: string

Наименование датчика

provider_id: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

is_active: boolean

Статус активности датчика

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url: string

Адрес сервера

}

}]

}

Пример

{...}

"truck_info_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ownership_type":0,

"type":0,

"car_type_id":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"manufacture_year":0,

"hidden_in_firm_info":false,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"external_id":"string",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"photos":[...],

{...}

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"file_id":"string",

"path":"string",

"name":"string"

}

"sensors":[...]

{...}

"sensor_id":0,

"sensor_name":"string",

"provider_id":0,

"provider_sensor_id":"string",

"is_active":false,

"unactivate_date":"1970-01-01T00:00:00.000Z",

"host":{...}

"sensor_host_id":0,

"url":"string"

}

]

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Редактирование транспортного средства

put /gw/oauth2/catalogs/v1.2/trucks/{truckId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`truckId` обязательный	string (guid)	`path`	Id транспортного средства Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Модель

{...}

type: enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

manufacture_year: int32 (nullable)

Год выпуска

ownership_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

phone_number: string

Номер телефона

bind_phone: boolean (nullable)

Эксклюзивный доступ к приложению Ати-Водитель

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

hidden_in_firm_info: boolean

Не отображать в карточке фирмы.

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

truck_passport_number: string

Номер ПТС

external_id: string

Идентификатор

sensors:[{...}]

Датчики мониторинга

sensor_id: int32

Идентификатор датчика

sensor_name*: string

Минимальное количество символов: 1

Наименование датчика

provider_id*: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host*:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url*: string

Минимальное количество символов: 1

Адрес сервера

}

}]

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/trucks/{truckId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"type":0,"car_type_id":0,"brand_id":0,"model":"string","number":"string","manufacture_year":0,"ownership_type":0,"phone_number":"string","bind_phone":false,"capacity":0.5,"volume":0.5,"length":0.5,"width":0.5,"height":0.5,"hidden_in_firm_info":false,"vin":"string","vrc":"string","body_number":"string","can_refrigerator":false,"has_gen_set":false,"dimension":0,"truck_owner_name":"string","can_carry_heavy_container":false,"can_carry_tall_container":false,"truck_passport_number":"string","external_id":"string","sensors":[{"sensor_id":0,"sensor_name":"string","provider_id":0,"provider_sensor_id":"string","unactivate_date":"1970-01-01T00:00:00.000Z","host":{"sensor_host_id":0,"url":"string"}}]}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/trucks/{truckId}", "{""type"":0,""car_type_id"":0,""brand_id"":0,""model"":""string"",""number"":""string"",""manufacture_year"":0,""ownership_type"":0,""phone_number"":""string"",""bind_phone"":false,""capacity"":0.5,""volume"":0.5,""length"":0.5,""width"":0.5,""height"":0.5,""hidden_in_firm_info"":false,""vin"":""string"",""vrc"":""string"",""body_number"":""string"",""can_refrigerator"":false,""has_gen_set"":false,""dimension"":0,""truck_owner_name"":""string"",""can_carry_heavy_container"":false,""can_carry_tall_container"":false,""truck_passport_number"":""string"",""external_id"":""string"",""sensors"":[{""sensor_id"":0,""sensor_name"":""string"",""provider_id"":0,""provider_sensor_id"":""string"",""unactivate_date"":""1970-01-01T00:00:00.000Z"",""host"":{""sensor_host_id"":0,""url"":""string""}}]}");

Ответ

200 Отредактированное транспортное средство

Модель

{...}

truck_info_id: guid

Id транспортного средства

related_id: guid (nullable)

Id связанного транспортного средства

is_attracted_truck: boolean

Привлеченное ТС. Устарело, используйте ownership_type

deprecated

ownership_type:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность супругов
5 - Безвозмездное пользование

type:

Тип транспортного средства

* 1 — Грузовик
* 2 — Тягач
* 4 — Полуприцеп
* 8 — Прицеп

ONE-OF

enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

car_type_id: int32

Тип кузова
Значение из словаря кузовов АТИ

description: string

Короткое описание

brand_id: int32 (nullable)

Марка
Значение из словаря

model: string

Модель
Значение из словаря

number: string

Госномер

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

last_deal_related_id: guid (nullable)

Id связанного во время последней сделки транспортного средства

manufacture_year: int32 (nullable)

Год выпуска

hidden_in_firm_info: boolean

Не отображать в карточке фирмы

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: int32 (nullable)

Размерность контейнера
Значение из словаря

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

external_id: string

Идентификатор

scans:[{...}]

Сканы документов ТС

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[3, 4, 6, 7, 8]

Тип документа

3 — Скан ПТС
4 — Скан пластикового ПТС
6 — Скан договора аренеды
7 — Скан свидетельства о браке
8 — Скан договора безвозмездного пользования

}]

photos:[{...}]

Фото ТС

owner_id: guid

id: guid

Id фото

file_id: string

path: string

Адрес расположения файла в хранилище

Имя файла

}]

sensors:[{...}]

Датчики мониторинга транспорта

sensor_id: int32

Идентификатор датчика

sensor_name: string

Наименование датчика

provider_id: int32

Идентификатор поставщика датчиков мониторинга транспорта

provider_sensor_id: string

Идентификатор датчика из внешней системы мониторинга

is_active: boolean

Статус активности датчика

unactivate_date: date-time (nullable)

Дата окончания действия датчика

host:

Информация о сервере поставщика устройства мониторинга транспорта

ONE-OF

1:{...}

Информация о сервере поставщика устройства мониторинга транспорта

sensor_host_id: int32

Идентификатор сервера

url: string

Адрес сервера

}

}]

}

Пример

{...}

"truck_info_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ownership_type":0,

"type":0,

"car_type_id":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"manufacture_year":0,

"hidden_in_firm_info":false,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"external_id":"string",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"photos":[...],

{...}

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"file_id":"string",

"path":"string",

"name":"string"

}

"sensors":[...]

{...}

"sensor_id":0,

"sensor_name":"string",

"provider_id":0,

"provider_sensor_id":"string",

"is_active":false,

"unactivate_date":"1970-01-01T00:00:00.000Z",

"host":{...}

"sensor_host_id":0,

"url":"string"

}

]

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Версия

Удаление транспортного средства

delete /v1.2/catalogs/trucks/{truckId}

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`truckId` обязательный	string (guid)	`path`	Id транспортного средства Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/trucks/{truckId}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.2/catalogs/trucks/{truckId}");

Ответ

200 Успешное удаление транспортного средства

Успешный ответ

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Удаление транспортного средства

delete /gw/oauth2/catalogs/v1.2/trucks/{truckId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`truckId` обязательный	string (guid)	`path`	Id транспортного средства Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/trucks/{truckId}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/trucks/{truckId}");

Ответ

200 Успешное удаление транспортного средства

Успешный ответ

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Методы для работы с водителями

Версия

Получение водителей пользователя

get /v1.2/catalogs/drivers

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`cargoOwnerAtiId`	string	`query`	Пример: `string`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/drivers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.2/catalogs/drivers");

Ответ

200 Список водителей

Модель

[{...}]

driver_id: guid

Id водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone:

Информация о номерe телефона водителя

ONE-OF

1:{...}

phone: decimal

Номер телефона

phone_string: string

Номер телефона, как указан пользователем

presence:

Статус приложения АТИ Водитель

ONE-OF

1:{...}

phone: decimal

Номер телефона, приведенный к числовому формату

initial_phone: string

Номер телефона в том виде, в котором его указал пользователь

last_active: date-time (nullable)

Время последней активности в приложении

has_tracker: boolean (nullable)

Авторизация в приложении

sms_invite_status:

Статус приглашения в приложение

ONE-OF

1:{...}

invite_sent: boolean

Было ли отправлено приглашение

contact_name: string

Имя пригласившего контакта

firm_id: int32 (nullable)

Id пригласившей фирмы

contact_id: int32 (nullable)

Id пригласившего контакт

sms_status:

Статус отправки СМС

* 0 - Нет информации
* 1 - Создано
* 2 - Ошибка
* 3 - Отправлено
* 4 - Доставлено

ONE-OF

enum

[0, 1, 2, 3, 4]

Статус отправки СМС

0 - Нет информации
1 - Создано
2 - Ошибка
3 - Отправлено
4 - Доставлено

when: date-time (nullable)

Время отправки SMS

}

binding:

Информация об актуальной привязке

ONE-OF

1:{...}

Информация о привязке (Эксклюзивности) номера телефона

status:

Статус привязки

* 0 - Эксклюзивный доступ
* 1 - Запрос на эксклюзивный доступ
* 2 - Запрос отклонен владельцем номера телефона
* 3 - Фирма "уволила" владельца номера
* 4 - Владелец номера "уволился"
* 5 - Запрос удален

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Статус привязки

0 - Эксклюзивный доступ
1 - Запрос на эксклюзивный доступ
2 - Запрос отклонен владельцем номера телефона
3 - Фирма "уволила" владельца номера
4 - Владелец номера "уволился"
5 - Запрос удален

account_id: string

Фирма, запрашивающая "Эксклюзивный доступ"

firm_name: string

Название фирмы, запрашивающей "Эксклюзивный доступ"

owner_type:

Тип сущности, к которой привязан телефон

* 0 — Водитель
* 1 — ТС

ONE-OF

enum

[0, 1]

Тип сущности

0 — Водитель
1 — ТС

}

binding_type:

Тип привязки (Эксклюзивности) номера телефона

* 0 - Номер не привязан
* 1 - Номер привязан к водителю текущей фирмы
* 2 - Номер привязан к ТС текущей фирмы
* 3 - Номер привязан к водителю другой фирмы
* 4 - Номер привязан к ТС другой фирмы

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4]

Тип привязки (Эксклюзивности) номера телефона

0 - Номер не привязан
1 - Номер привязан к водителю текущей фирмы
2 - Номер привязан к ТС текущей фирмы
3 - Номер привязан к водителю другой фирмы
4 - Номер привязан к ТС другой фирмы

}

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

related_id: guid (nullable)

Идентификатор связанного ТС, которое пользователь задал в кабинете

last_deal_related_id: guid (nullable)

Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы документов водителя

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[1, 2]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта

}]

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке у запрашиваемого грузовладельца

external_id: string

Идентификатор

}]

Пример

[...]

{...}

"driver_id":"c063e1c5-a58f-4f6b-b805-62d0715f4fba",

"first_name":"Иван",

"second_name":"Иванов",

"patronymic":"Иванович",

"phone":{...},

"phone":0.5,

"phone_string":"string",

"presence":{...},

"phone":0.5,

"initial_phone":"string",

"last_active":"1970-01-01T00:00:00.000Z",

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"firm_id":0,

"contact_id":0,

"sms_status":0,

"when":"1970-01-01T00:00:00.000Z"

}

"binding":{...},

"status":0,

"account_id":"string",

"firm_name":"string",

"owner_type":0

"binding_type":0

"driver_license_number":"77 77 123456",

"driver_license_when_issued":"1970-01-01T00:00:00.000Z",

"passport_series":"4010",

"passport_number":"123456",

"passport_issued_by":"УФМС России",

"passport_when_issued":"2018-01-01",

"registration":"гор. Санкт-Петербург",

"is_attracted_driver":false,

"related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"last_deal_related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"description":"Иванов Иван Иванович",

"attracted_from":"ООО Название фирмы",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"external_id":"string"

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Получение водителей пользователя

get /gw/oauth2/catalogs/v1.2/drivers

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`cargoOwnerAtiId`	string	`query`	Пример: `string`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/drivers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/drivers");

Ответ

200 Список водителей

Модель

[{...}]

driver_id: guid

Id водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone:

Информация о номерe телефона водителя

ONE-OF

1:{...}

phone: decimal

Номер телефона

phone_string: string

Номер телефона, как указан пользователем

presence:

Статус приложения АТИ Водитель

ONE-OF

1:{...}

phone: decimal

Номер телефона, приведенный к числовому формату

initial_phone: string

Номер телефона в том виде, в котором его указал пользователь

last_active: date-time (nullable)

Время последней активности в приложении

has_tracker: boolean (nullable)

Авторизация в приложении

sms_invite_status:

Статус приглашения в приложение

ONE-OF

1:{...}

invite_sent: boolean

Было ли отправлено приглашение

contact_name: string

Имя пригласившего контакта

firm_id: int32 (nullable)

Id пригласившей фирмы

contact_id: int32 (nullable)

Id пригласившего контакт

sms_status:

Статус отправки СМС

* 0 - Нет информации
* 1 - Создано
* 2 - Ошибка
* 3 - Отправлено
* 4 - Доставлено

ONE-OF

enum

[0, 1, 2, 3, 4]

Статус отправки СМС

0 - Нет информации
1 - Создано
2 - Ошибка
3 - Отправлено
4 - Доставлено

when: date-time (nullable)

Время отправки SMS

}

binding:

Информация об актуальной привязке

ONE-OF

1:{...}

Информация о привязке (Эксклюзивности) номера телефона

status:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Статус привязки

0 - Эксклюзивный доступ
1 - Запрос на эксклюзивный доступ
2 - Запрос отклонен владельцем номера телефона
3 - Фирма "уволила" владельца номера
4 - Владелец номера "уволился"
5 - Запрос удален

account_id: string

Фирма, запрашивающая "Эксклюзивный доступ"

firm_name: string

Название фирмы, запрашивающей "Эксклюзивный доступ"

owner_type:

Тип сущности, к которой привязан телефон

* 0 — Водитель
* 1 — ТС

ONE-OF

enum

[0, 1]

Тип сущности

0 — Водитель
1 — ТС

}

binding_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4]

Тип привязки (Эксклюзивности) номера телефона

0 - Номер не привязан
1 - Номер привязан к водителю текущей фирмы
2 - Номер привязан к ТС текущей фирмы
3 - Номер привязан к водителю другой фирмы
4 - Номер привязан к ТС другой фирмы

}

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

related_id: guid (nullable)

Идентификатор связанного ТС, которое пользователь задал в кабинете

last_deal_related_id: guid (nullable)

Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы документов водителя

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[1, 2]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта

}]

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке у запрашиваемого грузовладельца

external_id: string

Идентификатор

}]

Пример

[...]

{...}

"driver_id":"c063e1c5-a58f-4f6b-b805-62d0715f4fba",

"first_name":"Иван",

"second_name":"Иванов",

"patronymic":"Иванович",

"phone":{...},

"phone":0.5,

"phone_string":"string",

"presence":{...},

"phone":0.5,

"initial_phone":"string",

"last_active":"1970-01-01T00:00:00.000Z",

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"firm_id":0,

"contact_id":0,

"sms_status":0,

"when":"1970-01-01T00:00:00.000Z"

}

"binding":{...},

"status":0,

"account_id":"string",

"firm_name":"string",

"owner_type":0

"binding_type":0

"driver_license_number":"77 77 123456",

"driver_license_when_issued":"1970-01-01T00:00:00.000Z",

"passport_series":"4010",

"passport_number":"123456",

"passport_issued_by":"УФМС России",

"passport_when_issued":"2018-01-01",

"registration":"гор. Санкт-Петербург",

"is_attracted_driver":false,

"related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"last_deal_related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"description":"Иванов Иван Иванович",

"attracted_from":"ООО Название фирмы",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"external_id":"string"

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Версия

Создание водителя

post /v1.2/catalogs/drivers

Модель и примеры
Консоль

Параметры

Параметров нет

Запрос

Модель

{...}

Данные водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone_number: string

Номер телефона

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан паспорт

passport_when_issued: date-time

Когда выдан паспорт

registration: string

Адрес регистрации

is_attracted_driver: boolean

Флаг привлеченного водителя

attracted_from: string

Фирма, от которой привлечен водитель

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

external_id: string

Идентификатор

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/drivers' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"first_name":"Иван","second_name":"Иванов","patronymic":"Иванович","phone_number":"+7(910)333-33-33","driver_license_number":"77 77 123456","driver_license_when_issued":"2018-01-01","passport_series":"4010","passport_number":"123456","passport_issued_by":"УФМС России","passport_when_issued":"2018-01-01","registration":"гор. Санкт-Петербург","is_attracted_driver":false,"attracted_from":"ООО Название фирмы","date_of_birth":"1985-01-01","department_code_in_passport":"string","driver_inn":"string","external_id":"string"}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1.2/catalogs/drivers", "{""first_name"":""Иван"",""second_name"":""Иванов"",""patronymic"":""Иванович"",""phone_number"":""+7(910)333-33-33"",""driver_license_number"":""77 77 123456"",""driver_license_when_issued"":""2018-01-01"",""passport_series"":""4010"",""passport_number"":""123456"",""passport_issued_by"":""УФМС России"",""passport_when_issued"":""2018-01-01"",""registration"":""гор. Санкт-Петербург"",""is_attracted_driver"":false,""attracted_from"":""ООО Название фирмы"",""date_of_birth"":""1985-01-01"",""department_code_in_passport"":""string"",""driver_inn"":""string"",""external_id"":""string""}");

Ответ

200 Созданный водитель

Модель

{...}

driver_id: guid

Id водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone:

Информация о номерe телефона водителя

ONE-OF

1:{...}

phone: decimal

Номер телефона

phone_string: string

Номер телефона, как указан пользователем

presence:

Статус приложения АТИ Водитель

ONE-OF

1:{...}

phone: decimal

Номер телефона, приведенный к числовому формату

initial_phone: string

Номер телефона в том виде, в котором его указал пользователь

last_active: date-time (nullable)

Время последней активности в приложении

has_tracker: boolean (nullable)

Авторизация в приложении

sms_invite_status:

Статус приглашения в приложение

ONE-OF

1:{...}

invite_sent: boolean

Было ли отправлено приглашение

contact_name: string

Имя пригласившего контакта

firm_id: int32 (nullable)

Id пригласившей фирмы

contact_id: int32 (nullable)

Id пригласившего контакт

sms_status:

Статус отправки СМС

* 0 - Нет информации
* 1 - Создано
* 2 - Ошибка
* 3 - Отправлено
* 4 - Доставлено

ONE-OF

enum

[0, 1, 2, 3, 4]

Статус отправки СМС

0 - Нет информации
1 - Создано
2 - Ошибка
3 - Отправлено
4 - Доставлено

when: date-time (nullable)

Время отправки SMS

}

binding:

Информация об актуальной привязке

ONE-OF

1:{...}

Информация о привязке (Эксклюзивности) номера телефона

status:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Статус привязки

0 - Эксклюзивный доступ
1 - Запрос на эксклюзивный доступ
2 - Запрос отклонен владельцем номера телефона
3 - Фирма "уволила" владельца номера
4 - Владелец номера "уволился"
5 - Запрос удален

account_id: string

Фирма, запрашивающая "Эксклюзивный доступ"

firm_name: string

Название фирмы, запрашивающей "Эксклюзивный доступ"

owner_type:

Тип сущности, к которой привязан телефон

* 0 — Водитель
* 1 — ТС

ONE-OF

enum

[0, 1]

Тип сущности

0 — Водитель
1 — ТС

}

binding_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4]

Тип привязки (Эксклюзивности) номера телефона

0 - Номер не привязан
1 - Номер привязан к водителю текущей фирмы
2 - Номер привязан к ТС текущей фирмы
3 - Номер привязан к водителю другой фирмы
4 - Номер привязан к ТС другой фирмы

}

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

related_id: guid (nullable)

Идентификатор связанного ТС, которое пользователь задал в кабинете

last_deal_related_id: guid (nullable)

Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы документов водителя

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[1, 2]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта

}]

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке у запрашиваемого грузовладельца

external_id: string

Идентификатор

}

Пример

{...}

"driver_id":"c063e1c5-a58f-4f6b-b805-62d0715f4fba",

"first_name":"Иван",

"second_name":"Иванов",

"patronymic":"Иванович",

"phone":{...},

"phone":0.5,

"phone_string":"string",

"presence":{...},

"phone":0.5,

"initial_phone":"string",

"last_active":"1970-01-01T00:00:00.000Z",

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"firm_id":0,

"contact_id":0,

"sms_status":0,

"when":"1970-01-01T00:00:00.000Z"

}

"binding":{...},

"status":0,

"account_id":"string",

"firm_name":"string",

"owner_type":0

"binding_type":0

"driver_license_number":"77 77 123456",

"driver_license_when_issued":"1970-01-01T00:00:00.000Z",

"passport_series":"4010",

"passport_number":"123456",

"passport_issued_by":"УФМС России",

"passport_when_issued":"2018-01-01",

"registration":"гор. Санкт-Петербург",

"is_attracted_driver":false,

"related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"last_deal_related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"description":"Иванов Иван Иванович",

"attracted_from":"ООО Название фирмы",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"external_id":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Создание водителя

post /gw/oauth2/catalogs/v1.2/drivers

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметров нет

Запрос

Модель

{...}

Данные водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone_number: string

Номер телефона

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан паспорт

passport_when_issued: date-time

Когда выдан паспорт

registration: string

Адрес регистрации

is_attracted_driver: boolean

Флаг привлеченного водителя

attracted_from: string

Фирма, от которой привлечен водитель

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

external_id: string

Идентификатор

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/drivers' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"first_name":"Иван","second_name":"Иванов","patronymic":"Иванович","phone_number":"+7(910)333-33-33","driver_license_number":"77 77 123456","driver_license_when_issued":"2018-01-01","passport_series":"4010","passport_number":"123456","passport_issued_by":"УФМС России","passport_when_issued":"2018-01-01","registration":"гор. Санкт-Петербург","is_attracted_driver":false,"attracted_from":"ООО Название фирмы","date_of_birth":"1985-01-01","department_code_in_passport":"string","driver_inn":"string","external_id":"string"}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/drivers", "{""first_name"":""Иван"",""second_name"":""Иванов"",""patronymic"":""Иванович"",""phone_number"":""+7(910)333-33-33"",""driver_license_number"":""77 77 123456"",""driver_license_when_issued"":""2018-01-01"",""passport_series"":""4010"",""passport_number"":""123456"",""passport_issued_by"":""УФМС России"",""passport_when_issued"":""2018-01-01"",""registration"":""гор. Санкт-Петербург"",""is_attracted_driver"":false,""attracted_from"":""ООО Название фирмы"",""date_of_birth"":""1985-01-01"",""department_code_in_passport"":""string"",""driver_inn"":""string"",""external_id"":""string""}");

Ответ

200 Созданный водитель

Модель

{...}

driver_id: guid

Id водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone:

Информация о номерe телефона водителя

ONE-OF

1:{...}

phone: decimal

Номер телефона

phone_string: string

Номер телефона, как указан пользователем

presence:

Статус приложения АТИ Водитель

ONE-OF

1:{...}

phone: decimal

Номер телефона, приведенный к числовому формату

initial_phone: string

Номер телефона в том виде, в котором его указал пользователь

last_active: date-time (nullable)

Время последней активности в приложении

has_tracker: boolean (nullable)

Авторизация в приложении

sms_invite_status:

Статус приглашения в приложение

ONE-OF

1:{...}

invite_sent: boolean

Было ли отправлено приглашение

contact_name: string

Имя пригласившего контакта

firm_id: int32 (nullable)

Id пригласившей фирмы

contact_id: int32 (nullable)

Id пригласившего контакт

sms_status:

Статус отправки СМС

* 0 - Нет информации
* 1 - Создано
* 2 - Ошибка
* 3 - Отправлено
* 4 - Доставлено

ONE-OF

enum

[0, 1, 2, 3, 4]

Статус отправки СМС

0 - Нет информации
1 - Создано
2 - Ошибка
3 - Отправлено
4 - Доставлено

when: date-time (nullable)

Время отправки SMS

}

binding:

Информация об актуальной привязке

ONE-OF

1:{...}

Информация о привязке (Эксклюзивности) номера телефона

status:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Статус привязки

0 - Эксклюзивный доступ
1 - Запрос на эксклюзивный доступ
2 - Запрос отклонен владельцем номера телефона
3 - Фирма "уволила" владельца номера
4 - Владелец номера "уволился"
5 - Запрос удален

account_id: string

Фирма, запрашивающая "Эксклюзивный доступ"

firm_name: string

Название фирмы, запрашивающей "Эксклюзивный доступ"

owner_type:

Тип сущности, к которой привязан телефон

* 0 — Водитель
* 1 — ТС

ONE-OF

enum

[0, 1]

Тип сущности

0 — Водитель
1 — ТС

}

binding_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4]

Тип привязки (Эксклюзивности) номера телефона

0 - Номер не привязан
1 - Номер привязан к водителю текущей фирмы
2 - Номер привязан к ТС текущей фирмы
3 - Номер привязан к водителю другой фирмы
4 - Номер привязан к ТС другой фирмы

}

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

related_id: guid (nullable)

Идентификатор связанного ТС, которое пользователь задал в кабинете

last_deal_related_id: guid (nullable)

Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы документов водителя

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[1, 2]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта

}]

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке у запрашиваемого грузовладельца

external_id: string

Идентификатор

}

Пример

{...}

"driver_id":"c063e1c5-a58f-4f6b-b805-62d0715f4fba",

"first_name":"Иван",

"second_name":"Иванов",

"patronymic":"Иванович",

"phone":{...},

"phone":0.5,

"phone_string":"string",

"presence":{...},

"phone":0.5,

"initial_phone":"string",

"last_active":"1970-01-01T00:00:00.000Z",

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"firm_id":0,

"contact_id":0,

"sms_status":0,

"when":"1970-01-01T00:00:00.000Z"

}

"binding":{...},

"status":0,

"account_id":"string",

"firm_name":"string",

"owner_type":0

"binding_type":0

"driver_license_number":"77 77 123456",

"driver_license_when_issued":"1970-01-01T00:00:00.000Z",

"passport_series":"4010",

"passport_number":"123456",

"passport_issued_by":"УФМС России",

"passport_when_issued":"2018-01-01",

"registration":"гор. Санкт-Петербург",

"is_attracted_driver":false,

"related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"last_deal_related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"description":"Иванов Иван Иванович",

"attracted_from":"ООО Название фирмы",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"external_id":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Версия

Получение водителя пользователя

get /v1.2/catalogs/drivers/{driverId}

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`driverId` обязательный	string (guid)	`path`	Id водителя Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`
`cargoOwnerAtiId`	string	`query`	Код АТИ фирмы-грузовладельца, для проверки Черного списка Пример: `string`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/drivers/{driverId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.2/catalogs/drivers/{driverId}");

Ответ

200 Водитель

Модель

{...}

driver_id: guid

Id водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone:

Информация о номерe телефона водителя

ONE-OF

1:{...}

phone: decimal

Номер телефона

phone_string: string

Номер телефона, как указан пользователем

presence:

Статус приложения АТИ Водитель

ONE-OF

1:{...}

phone: decimal

Номер телефона, приведенный к числовому формату

initial_phone: string

Номер телефона в том виде, в котором его указал пользователь

last_active: date-time (nullable)

Время последней активности в приложении

has_tracker: boolean (nullable)

Авторизация в приложении

sms_invite_status:

Статус приглашения в приложение

ONE-OF

1:{...}

invite_sent: boolean

Было ли отправлено приглашение

contact_name: string

Имя пригласившего контакта

firm_id: int32 (nullable)

Id пригласившей фирмы

contact_id: int32 (nullable)

Id пригласившего контакт

sms_status:

Статус отправки СМС

* 0 - Нет информации
* 1 - Создано
* 2 - Ошибка
* 3 - Отправлено
* 4 - Доставлено

ONE-OF

enum

[0, 1, 2, 3, 4]

Статус отправки СМС

0 - Нет информации
1 - Создано
2 - Ошибка
3 - Отправлено
4 - Доставлено

when: date-time (nullable)

Время отправки SMS

}

binding:

Информация об актуальной привязке

ONE-OF

1:{...}

Информация о привязке (Эксклюзивности) номера телефона

status:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Статус привязки

0 - Эксклюзивный доступ
1 - Запрос на эксклюзивный доступ
2 - Запрос отклонен владельцем номера телефона
3 - Фирма "уволила" владельца номера
4 - Владелец номера "уволился"
5 - Запрос удален

account_id: string

Фирма, запрашивающая "Эксклюзивный доступ"

firm_name: string

Название фирмы, запрашивающей "Эксклюзивный доступ"

owner_type:

Тип сущности, к которой привязан телефон

* 0 — Водитель
* 1 — ТС

ONE-OF

enum

[0, 1]

Тип сущности

0 — Водитель
1 — ТС

}

binding_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4]

Тип привязки (Эксклюзивности) номера телефона

0 - Номер не привязан
1 - Номер привязан к водителю текущей фирмы
2 - Номер привязан к ТС текущей фирмы
3 - Номер привязан к водителю другой фирмы
4 - Номер привязан к ТС другой фирмы

}

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

related_id: guid (nullable)

Идентификатор связанного ТС, которое пользователь задал в кабинете

last_deal_related_id: guid (nullable)

Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы документов водителя

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[1, 2]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта

}]

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке у запрашиваемого грузовладельца

external_id: string

Идентификатор

}

Пример

{...}

"driver_id":"c063e1c5-a58f-4f6b-b805-62d0715f4fba",

"first_name":"Иван",

"second_name":"Иванов",

"patronymic":"Иванович",

"phone":{...},

"phone":0.5,

"phone_string":"string",

"presence":{...},

"phone":0.5,

"initial_phone":"string",

"last_active":"1970-01-01T00:00:00.000Z",

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"firm_id":0,

"contact_id":0,

"sms_status":0,

"when":"1970-01-01T00:00:00.000Z"

}

"binding":{...},

"status":0,

"account_id":"string",

"firm_name":"string",

"owner_type":0

"binding_type":0

"driver_license_number":"77 77 123456",

"driver_license_when_issued":"1970-01-01T00:00:00.000Z",

"passport_series":"4010",

"passport_number":"123456",

"passport_issued_by":"УФМС России",

"passport_when_issued":"2018-01-01",

"registration":"гор. Санкт-Петербург",

"is_attracted_driver":false,

"related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"last_deal_related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"description":"Иванов Иван Иванович",

"attracted_from":"ООО Название фирмы",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"external_id":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Получение водителя пользователя

get /gw/oauth2/catalogs/v1.2/drivers/{driverId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`driverId` обязательный	string (guid)	`path`	Id водителя Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`
`cargoOwnerAtiId`	string	`query`	Код АТИ фирмы-грузовладельца, для проверки Черного списка Пример: `string`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/drivers/{driverId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/drivers/{driverId}");

Ответ

200 Водитель

Модель

{...}

driver_id: guid

Id водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone:

Информация о номерe телефона водителя

ONE-OF

1:{...}

phone: decimal

Номер телефона

phone_string: string

Номер телефона, как указан пользователем

presence:

Статус приложения АТИ Водитель

ONE-OF

1:{...}

phone: decimal

Номер телефона, приведенный к числовому формату

initial_phone: string

Номер телефона в том виде, в котором его указал пользователь

last_active: date-time (nullable)

Время последней активности в приложении

has_tracker: boolean (nullable)

Авторизация в приложении

sms_invite_status:

Статус приглашения в приложение

ONE-OF

1:{...}

invite_sent: boolean

Было ли отправлено приглашение

contact_name: string

Имя пригласившего контакта

firm_id: int32 (nullable)

Id пригласившей фирмы

contact_id: int32 (nullable)

Id пригласившего контакт

sms_status:

Статус отправки СМС

* 0 - Нет информации
* 1 - Создано
* 2 - Ошибка
* 3 - Отправлено
* 4 - Доставлено

ONE-OF

enum

[0, 1, 2, 3, 4]

Статус отправки СМС

0 - Нет информации
1 - Создано
2 - Ошибка
3 - Отправлено
4 - Доставлено

when: date-time (nullable)

Время отправки SMS

}

binding:

Информация об актуальной привязке

ONE-OF

1:{...}

Информация о привязке (Эксклюзивности) номера телефона

status:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Статус привязки

0 - Эксклюзивный доступ
1 - Запрос на эксклюзивный доступ
2 - Запрос отклонен владельцем номера телефона
3 - Фирма "уволила" владельца номера
4 - Владелец номера "уволился"
5 - Запрос удален

account_id: string

Фирма, запрашивающая "Эксклюзивный доступ"

firm_name: string

Название фирмы, запрашивающей "Эксклюзивный доступ"

owner_type:

Тип сущности, к которой привязан телефон

* 0 — Водитель
* 1 — ТС

ONE-OF

enum

[0, 1]

Тип сущности

0 — Водитель
1 — ТС

}

binding_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4]

Тип привязки (Эксклюзивности) номера телефона

0 - Номер не привязан
1 - Номер привязан к водителю текущей фирмы
2 - Номер привязан к ТС текущей фирмы
3 - Номер привязан к водителю другой фирмы
4 - Номер привязан к ТС другой фирмы

}

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

related_id: guid (nullable)

Идентификатор связанного ТС, которое пользователь задал в кабинете

last_deal_related_id: guid (nullable)

Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы документов водителя

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[1, 2]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта

}]

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке у запрашиваемого грузовладельца

external_id: string

Идентификатор

}

Пример

{...}

"driver_id":"c063e1c5-a58f-4f6b-b805-62d0715f4fba",

"first_name":"Иван",

"second_name":"Иванов",

"patronymic":"Иванович",

"phone":{...},

"phone":0.5,

"phone_string":"string",

"presence":{...},

"phone":0.5,

"initial_phone":"string",

"last_active":"1970-01-01T00:00:00.000Z",

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"firm_id":0,

"contact_id":0,

"sms_status":0,

"when":"1970-01-01T00:00:00.000Z"

}

"binding":{...},

"status":0,

"account_id":"string",

"firm_name":"string",

"owner_type":0

"binding_type":0

"driver_license_number":"77 77 123456",

"driver_license_when_issued":"1970-01-01T00:00:00.000Z",

"passport_series":"4010",

"passport_number":"123456",

"passport_issued_by":"УФМС России",

"passport_when_issued":"2018-01-01",

"registration":"гор. Санкт-Петербург",

"is_attracted_driver":false,

"related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"last_deal_related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"description":"Иванов Иван Иванович",

"attracted_from":"ООО Название фирмы",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"external_id":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Версия

Редактирование водителя

put /v1.2/catalogs/drivers/{driverId}

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`driverId` обязательный	string (guid)	`path`	Id водителя Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Модель

{...}

Данные водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone_number: string

Номер телефона

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан паспорт

passport_when_issued: date-time

Когда выдан паспорт

registration: string

Адрес регистрации

is_attracted_driver: boolean

Флаг привлеченного водителя

attracted_from: string

Фирма, от которой привлечен водитель

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

external_id: string

Идентификатор

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/drivers/{driverId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"first_name":"Иван","second_name":"Иванов","patronymic":"Иванович","phone_number":"+7(910)333-33-33","driver_license_number":"77 77 123456","driver_license_when_issued":"2018-01-01","passport_series":"4010","passport_number":"123456","passport_issued_by":"УФМС России","passport_when_issued":"2018-01-01","registration":"гор. Санкт-Петербург","is_attracted_driver":false,"attracted_from":"ООО Название фирмы","date_of_birth":"1985-01-01","department_code_in_passport":"string","driver_inn":"string","external_id":"string"}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.2/catalogs/drivers/{driverId}", "{""first_name"":""Иван"",""second_name"":""Иванов"",""patronymic"":""Иванович"",""phone_number"":""+7(910)333-33-33"",""driver_license_number"":""77 77 123456"",""driver_license_when_issued"":""2018-01-01"",""passport_series"":""4010"",""passport_number"":""123456"",""passport_issued_by"":""УФМС России"",""passport_when_issued"":""2018-01-01"",""registration"":""гор. Санкт-Петербург"",""is_attracted_driver"":false,""attracted_from"":""ООО Название фирмы"",""date_of_birth"":""1985-01-01"",""department_code_in_passport"":""string"",""driver_inn"":""string"",""external_id"":""string""}");

Ответ

200 Отредактированный водитель

Модель

{...}

driver_id: guid

Id водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone:

Информация о номерe телефона водителя

ONE-OF

1:{...}

phone: decimal

Номер телефона

phone_string: string

Номер телефона, как указан пользователем

presence:

Статус приложения АТИ Водитель

ONE-OF

1:{...}

phone: decimal

Номер телефона, приведенный к числовому формату

initial_phone: string

Номер телефона в том виде, в котором его указал пользователь

last_active: date-time (nullable)

Время последней активности в приложении

has_tracker: boolean (nullable)

Авторизация в приложении

sms_invite_status:

Статус приглашения в приложение

ONE-OF

1:{...}

invite_sent: boolean

Было ли отправлено приглашение

contact_name: string

Имя пригласившего контакта

firm_id: int32 (nullable)

Id пригласившей фирмы

contact_id: int32 (nullable)

Id пригласившего контакт

sms_status:

Статус отправки СМС

* 0 - Нет информации
* 1 - Создано
* 2 - Ошибка
* 3 - Отправлено
* 4 - Доставлено

ONE-OF

enum

[0, 1, 2, 3, 4]

Статус отправки СМС

0 - Нет информации
1 - Создано
2 - Ошибка
3 - Отправлено
4 - Доставлено

when: date-time (nullable)

Время отправки SMS

}

binding:

Информация об актуальной привязке

ONE-OF

1:{...}

Информация о привязке (Эксклюзивности) номера телефона

status:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Статус привязки

0 - Эксклюзивный доступ
1 - Запрос на эксклюзивный доступ
2 - Запрос отклонен владельцем номера телефона
3 - Фирма "уволила" владельца номера
4 - Владелец номера "уволился"
5 - Запрос удален

account_id: string

Фирма, запрашивающая "Эксклюзивный доступ"

firm_name: string

Название фирмы, запрашивающей "Эксклюзивный доступ"

owner_type:

Тип сущности, к которой привязан телефон

* 0 — Водитель
* 1 — ТС

ONE-OF

enum

[0, 1]

Тип сущности

0 — Водитель
1 — ТС

}

binding_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4]

Тип привязки (Эксклюзивности) номера телефона

0 - Номер не привязан
1 - Номер привязан к водителю текущей фирмы
2 - Номер привязан к ТС текущей фирмы
3 - Номер привязан к водителю другой фирмы
4 - Номер привязан к ТС другой фирмы

}

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

related_id: guid (nullable)

Идентификатор связанного ТС, которое пользователь задал в кабинете

last_deal_related_id: guid (nullable)

Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы документов водителя

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[1, 2]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта

}]

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке у запрашиваемого грузовладельца

external_id: string

Идентификатор

}

Пример

{...}

"driver_id":"c063e1c5-a58f-4f6b-b805-62d0715f4fba",

"first_name":"Иван",

"second_name":"Иванов",

"patronymic":"Иванович",

"phone":{...},

"phone":0.5,

"phone_string":"string",

"presence":{...},

"phone":0.5,

"initial_phone":"string",

"last_active":"1970-01-01T00:00:00.000Z",

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"firm_id":0,

"contact_id":0,

"sms_status":0,

"when":"1970-01-01T00:00:00.000Z"

}

"binding":{...},

"status":0,

"account_id":"string",

"firm_name":"string",

"owner_type":0

"binding_type":0

"driver_license_number":"77 77 123456",

"driver_license_when_issued":"1970-01-01T00:00:00.000Z",

"passport_series":"4010",

"passport_number":"123456",

"passport_issued_by":"УФМС России",

"passport_when_issued":"2018-01-01",

"registration":"гор. Санкт-Петербург",

"is_attracted_driver":false,

"related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"last_deal_related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"description":"Иванов Иван Иванович",

"attracted_from":"ООО Название фирмы",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"external_id":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Редактирование водителя

put /gw/oauth2/catalogs/v1.2/drivers/{driverId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`driverId` обязательный	string (guid)	`path`	Id водителя Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Модель

{...}

Данные водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone_number: string

Номер телефона

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан паспорт

passport_when_issued: date-time

Когда выдан паспорт

registration: string

Адрес регистрации

is_attracted_driver: boolean

Флаг привлеченного водителя

attracted_from: string

Фирма, от которой привлечен водитель

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

external_id: string

Идентификатор

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/drivers/{driverId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"first_name":"Иван","second_name":"Иванов","patronymic":"Иванович","phone_number":"+7(910)333-33-33","driver_license_number":"77 77 123456","driver_license_when_issued":"2018-01-01","passport_series":"4010","passport_number":"123456","passport_issued_by":"УФМС России","passport_when_issued":"2018-01-01","registration":"гор. Санкт-Петербург","is_attracted_driver":false,"attracted_from":"ООО Название фирмы","date_of_birth":"1985-01-01","department_code_in_passport":"string","driver_inn":"string","external_id":"string"}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/drivers/{driverId}", "{""first_name"":""Иван"",""second_name"":""Иванов"",""patronymic"":""Иванович"",""phone_number"":""+7(910)333-33-33"",""driver_license_number"":""77 77 123456"",""driver_license_when_issued"":""2018-01-01"",""passport_series"":""4010"",""passport_number"":""123456"",""passport_issued_by"":""УФМС России"",""passport_when_issued"":""2018-01-01"",""registration"":""гор. Санкт-Петербург"",""is_attracted_driver"":false,""attracted_from"":""ООО Название фирмы"",""date_of_birth"":""1985-01-01"",""department_code_in_passport"":""string"",""driver_inn"":""string"",""external_id"":""string""}");

Ответ

200 Отредактированный водитель

Модель

{...}

driver_id: guid

Id водителя

first_name: string

Имя

second_name: string

Фамилия

patronymic: string

Отчество

phone:

Информация о номерe телефона водителя

ONE-OF

1:{...}

phone: decimal

Номер телефона

phone_string: string

Номер телефона, как указан пользователем

presence:

Статус приложения АТИ Водитель

ONE-OF

1:{...}

phone: decimal

Номер телефона, приведенный к числовому формату

initial_phone: string

Номер телефона в том виде, в котором его указал пользователь

last_active: date-time (nullable)

Время последней активности в приложении

has_tracker: boolean (nullable)

Авторизация в приложении

sms_invite_status:

Статус приглашения в приложение

ONE-OF

1:{...}

invite_sent: boolean

Было ли отправлено приглашение

contact_name: string

Имя пригласившего контакта

firm_id: int32 (nullable)

Id пригласившей фирмы

contact_id: int32 (nullable)

Id пригласившего контакт

sms_status:

Статус отправки СМС

* 0 - Нет информации
* 1 - Создано
* 2 - Ошибка
* 3 - Отправлено
* 4 - Доставлено

ONE-OF

enum

[0, 1, 2, 3, 4]

Статус отправки СМС

0 - Нет информации
1 - Создано
2 - Ошибка
3 - Отправлено
4 - Доставлено

when: date-time (nullable)

Время отправки SMS

}

binding:

Информация об актуальной привязке

ONE-OF

1:{...}

Информация о привязке (Эксклюзивности) номера телефона

status:

ONE-OF

enum

[0, 1, 2, 3, 4, 5]

Статус привязки

0 - Эксклюзивный доступ
1 - Запрос на эксклюзивный доступ
2 - Запрос отклонен владельцем номера телефона
3 - Фирма "уволила" владельца номера
4 - Владелец номера "уволился"
5 - Запрос удален

account_id: string

Фирма, запрашивающая "Эксклюзивный доступ"

firm_name: string

Название фирмы, запрашивающей "Эксклюзивный доступ"

owner_type:

Тип сущности, к которой привязан телефон

* 0 — Водитель
* 1 — ТС

ONE-OF

enum

[0, 1]

Тип сущности

0 — Водитель
1 — ТС

}

binding_type:

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4]

Тип привязки (Эксклюзивности) номера телефона

0 - Номер не привязан
1 - Номер привязан к водителю текущей фирмы
2 - Номер привязан к ТС текущей фирмы
3 - Номер привязан к водителю другой фирмы
4 - Номер привязан к ТС другой фирмы

}

driver_license_number: string

Номер водительского удостоверения

driver_license_when_issued: date-time (nullable)

Когда выдано водительское удостоверение

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

related_id: guid (nullable)

Идентификатор связанного ТС, которое пользователь задал в кабинете

last_deal_related_id: guid (nullable)

Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы документов водителя

scan_id: guid

Id скана

scan_owner_id: guid

scan_file_id: string

scan_path: string

Адрес расположения файла скана в хранилище

scan_name: string

Имя файла скана

scan_type: enum

[1, 2]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта

}]

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке у запрашиваемого грузовладельца

external_id: string

Идентификатор

}

Пример

{...}

"driver_id":"c063e1c5-a58f-4f6b-b805-62d0715f4fba",

"first_name":"Иван",

"second_name":"Иванов",

"patronymic":"Иванович",

"phone":{...},

"phone":0.5,

"phone_string":"string",

"presence":{...},

"phone":0.5,

"initial_phone":"string",

"last_active":"1970-01-01T00:00:00.000Z",

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"firm_id":0,

"contact_id":0,

"sms_status":0,

"when":"1970-01-01T00:00:00.000Z"

}

"binding":{...},

"status":0,

"account_id":"string",

"firm_name":"string",

"owner_type":0

"binding_type":0

"driver_license_number":"77 77 123456",

"driver_license_when_issued":"1970-01-01T00:00:00.000Z",

"passport_series":"4010",

"passport_number":"123456",

"passport_issued_by":"УФМС России",

"passport_when_issued":"2018-01-01",

"registration":"гор. Санкт-Петербург",

"is_attracted_driver":false,

"related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"last_deal_related_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29",

"description":"Иванов Иван Иванович",

"attracted_from":"ООО Название фирмы",

"scans":[...],

{...}

"scan_id":"1bb60c95-957b-473f-b664-4026533fa5a9",

"scan_owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"scan_file_id":"string",

"scan_path":"https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579",

"scan_name":"ВУ.pdf",

"scan_type":0

}

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"external_id":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Версия

Удаление водителя

delete /v1.2/catalogs/drivers/{driverId}

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`driverId` обязательный	string (guid)	`path`	Id водителя Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/drivers/{driverId}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.2/catalogs/drivers/{driverId}");

Ответ

200 Успешное удаление водителя, в ответе Id удалённого водителя

Модель

guid

Пример

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Удаление водителя

delete /gw/oauth2/catalogs/v1.2/drivers/{driverId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`driverId` обязательный	string (guid)	`path`	Id водителя Пример: `3fa85f64-5717-4562-b3fc-2c963f66afa6`

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/drivers/{driverId}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/drivers/{driverId}");

Ответ

200 Успешное удаление водителя, в ответе Id удалённого водителя

Модель

guid

Пример

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Метод для работы со связями сущностей справочников

Данный метод позволяет установить связь между траспортными средствами и водителями. Если указанное в запросе траснспортное средство или водитель уже были ранее связаны с другими сущностями, то при создании новой связи старые связи разрываются. Возможно передавать Id одной сущности для отвязывания её.

Версия

Создание связей Старые связи разрываются. Возможно передавать Id одной сущности для отвязывания её.

post /v1.2/catalogs/relations

Модель и примеры
Консоль

Параметры

Параметров нет

Запрос

Модель

{...}

Информация о связях

truck_id: guid (nullable)

Id грузовика

tractor_id: guid (nullable)

Id тягача

trailer_id: guid (nullable)

Id прицепа

semitrailer_id: guid (nullable)

Id полуприцепа

driver_ids: [guid]

Список Id водителей

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/catalogs/relations' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"truck_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29","tractor_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29","trailer_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29","semitrailer_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29","driver_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1.2/catalogs/relations", "{""truck_id"":""75fdfa06-287b-47ff-a6e7-1d9edfa5ac29"",""tractor_id"":""75fdfa06-287b-47ff-a6e7-1d9edfa5ac29"",""trailer_id"":""75fdfa06-287b-47ff-a6e7-1d9edfa5ac29"",""semitrailer_id"":""75fdfa06-287b-47ff-a6e7-1d9edfa5ac29"",""driver_ids"":[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]}");

Ответ

200 Успешное создание

Успешный ответ

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}

Создание связей Старые связи разрываются. Возможно передавать Id одной сущности для отвязывания её.

post /gw/oauth2/catalogs/v1.2/relations

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Модель и примеры
Консоль

Параметры

Параметров нет

Запрос

Модель

{...}

Информация о связях

truck_id: guid (nullable)

Id грузовика

tractor_id: guid (nullable)

Id тягача

trailer_id: guid (nullable)

Id прицепа

semitrailer_id: guid (nullable)

Id полуприцепа

driver_ids: [guid]

Список Id водителей

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/gw/oauth2/catalogs/v1.2/relations' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"truck_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29","tractor_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29","trailer_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29","semitrailer_id":"75fdfa06-287b-47ff-a6e7-1d9edfa5ac29","driver_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/gw/oauth2/catalogs/v1.2/relations", "{""truck_id"":""75fdfa06-287b-47ff-a6e7-1d9edfa5ac29"",""tractor_id"":""75fdfa06-287b-47ff-a6e7-1d9edfa5ac29"",""trailer_id"":""75fdfa06-287b-47ff-a6e7-1d9edfa5ac29"",""semitrailer_id"":""75fdfa06-287b-47ff-a6e7-1d9edfa5ac29"",""driver_ids"":[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]}");

Ответ

200 Успешное создание

Успешный ответ

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Пример

{...}

"error_code":"string",

"reason":"string"

}