Методы on База знаний DataMobile

checklists

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Чек-листов” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/checklists?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
checklists обязательное	object array	Массив объектов чек-листа

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

Возвращаются объекты checklist


[
 {
 "id": "checklist_id1",
 "name": "Осмотр ТС",
 "steps": [
 {
 "checklist_step_id": "checklist_step_id1",
 "position": 0
 },
 {
 "checklist_step_id": "checklist_step_id2",
 "position": 1
 }
 ]
 }
]

см. checklist

checklists/steps

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Шаги чек-листов” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/checklists/steps?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
checklist_steps обязательное	object array	Массив объектов шаг чек-листа

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

Возвращаются объекты checklist_step


[
 {
 "id": "checklist_step_id1",
 "name": "Уровень масла",
 "description": "Извлеките щуп с желтой рукояткой. Проверьте уровень масла на щупе",
 "data_type": 0
 "can_skip": false
 },
 {
 "id": "checklist_step_id2",
 "name": "Проверка двигателя",
 "description": "Верните щуп на место, проверьте что отсутствуют подтеки жидкостей в подкапотном пространстве. Сделайте фото подкапотного пространства",
 "data_type": 5
 "can_skip": true
 }
]

см. checklists_step

class_measures

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Связи единицы измерения наработки” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/class_measures?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
class_measures обязательное	object array	Массив объектов связи единицы измерения наработки

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

Возвращаются объекты class_measure


[
 {
 "class_id": "class_id1",
 "measure_id": "measure_id2"
 },
 {
 "class_id": "class_id2",
 "measure_id": "measure_id2"
 }
]

см. class_measure

defect_types

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Типы дефектов” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/defect_types?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
defect_types обязательное	object array	Массив объектов типа дефекта

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

Возвращаются объекты defect_type


[
 {
 "id": "defect_type_id1",
 "name": "Нарушения в работе навесного оборудования"
 },
 {
 "id": "defect_type_id2",
 "name": "Отказ электрооборудования"
 }
]

см. defect_type

device/data

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Проверка необходимости загрузки основных справочников

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/device/data?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
is_need_clear_class_measures	boolean	Признак очистки справочника связей групп объектов и единиц измерения
is_need_load_class_measures	boolean	Признак загрузки справочника связей групп объектов и единиц измерения
is_need_clear_defect_types	boolean	Признак очистки справочника типов дефектов
is_need_load_defect_types	boolean	Признак загрузки справочника типов дефектов
is_need_clear_materials	boolean	Признак очистки справочника материалов
is_need_load_materials	boolean	Признак загрузки справочника материалов
is_need_clear_measures	boolean	Признак очистки справочника единиц измерения
is_need_load_measures	boolean	Признак загрузки справочника единиц измерения
is_need_clear_node_attributes	boolean	Признак очистки справочника атрибутов узлов
is_need_load_node_attributes	boolean	Признак загрузки справочника атрибутов узлов
is_need_clear_nodes	boolean	Признак очистки справочника узлов
is_need_load_nodes	boolean	Признак загрузки справочника узлов
is_need_clear_repair_materials	boolean	Признак очистки справочника связей типов ремонтов с материалами
is_need_load_repair_materials	boolean	Признак загрузки справочника связей типов ремонтов с материалами
is_need_clear_repair_types	boolean	Признак очистки справочника типов ремонтов
is_need_load_repair_types	boolean	Признак загрузки справочника типов ремонтов
is_need_clear_unit_attributes	boolean	Признак очистки справочника атрибутов объектов
is_need_load_unit_attributes	boolean	Признак загрузки справочника атрибутов объектов
is_need_clear_unit_groups	boolean	Признак очистки справочника групп объектов
is_need_load_unit_groups	boolean	Признак загрузки справочника групп объектов
is_need_clear_units	boolean	Признак очистки справочника объектов
is_need_load_units	boolean	Признак загрузки справочника объектов
is_need_clear_checklist_steps	boolean	Признак очистки справочника шагов чек-листов
is_need_load_checklist_steps	boolean	Признак загрузки справочника шагов чек-листов
is_need_clear_checklists	boolean	Признак очистки чек-листов
is_need_load_checklists	boolean	Признак загрузки чек-листов
is_need_clear_user_groups	boolean	Признак очистки справочника бригад
is_need_load_user_groups	boolean	Признак загрузки справочника бригад
is_need_clear_users	boolean	Признак очистки справочника пользователей
is_need_load_users	boolean	Признак загрузки справочника пользователей
is_need_clear_defect_docs	boolean	Признак очистки документов дефектов
is_need_load_defect_docs	boolean	Признак загрузки документов дефектов
is_need_clear_repair_docs	boolean	Признак очистки документов ремонта
is_need_load_repair_docs	boolean	Признак загрузки документов ремонта
is_need_clear_checklist_docs	boolean	Признак очистки документов чек-листов
is_need_load_checklist_docs	boolean	Признак загрузки документов чек-листов

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


{
 "is_need_clear_class_measures": false,
 "is_need_load_class_measures": false,
 "is_need_clear_defect_types": false,
 "is_need_load_defect_types": false,
 "is_need_clear_materials": false,
 "is_need_load_materials": false,
 "is_need_clear_measures": false,
 "is_need_load_measures": false,
 "is_need_clear_node_attributes": false,
 "is_need_load_node_attributes": false,
 "is_need_clear_nodes": false,
 "is_need_load_nodes": false,
 "is_need_clear_repair_materials": false,
 "is_need_load_repair_materials": false,
 "is_need_clear_repair_types": false,
 "is_need_load_repair_types": false,
 "is_need_clear_unit_attributes": false,
 "is_need_load_unit_attributes": false,
 "is_need_clear_unit_groups": false,
 "is_need_load_unit_groups": false,
 "is_need_clear_units": false,
 "is_need_load_units": false,
 "is_need_clear_checklist_steps": false,
 "is_need_load_checklist_steps": false,
 "is_need_clear_checklists": false,
 "is_need_load_checklists": false,
 "is_need_clear_user_groups": false,
 "is_need_load_user_groups": false,
 "is_need_clear_users": false,
 "is_need_load_users": false,
 "is_need_clear_defect_docs": false,
 "is_need_load_defect_docs": false,
 "is_need_clear_repair_docs": false,
 "is_need_load_repair_docs": false,
 "is_need_clear_checklist_docs": false,
 "is_need_load_checklist_docs": false
}

device/login

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

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

Где используется

В форме авторизации

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/device/login?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус авторизации
device_name	string	Наименование устройства
accounting	object	Информация об учётной системе

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


{
 "is_success": true,
 "data": {
 "device_name": "ТСД",
 "accounting": {
 "arm_version": "31.10.24"
 }
 }
}

см. accounting

device/logout

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Выход из приложения на форму авторизации

Где используется

На владке “Прочее”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/device/logout?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус авторизации

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


{
 "is_success": true 
}

docs/checklists

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка документа чек-листа

Где используется

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

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
id	string	Идентификатор документа чек-листа
checklist_id	string	Идентификатор используемого чек-листа
values	object array	Массив объектов значений шагов чек-листа (см. checklist_doc_value)
repairs	object array	Массив объектов связей лога документа чек-листа и документа ремонта (см. checklist_doc_repair)
defects	object array	Массив объектов связей лога документа чек-листа и документа дефекта (см. checklist_doc_defect)
operate_times	object array	Массив объектов связей лога документа чек-листа и документа наработки (см. checklist_doc_operate_time)
images	object array	Массив объектов изображений

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/checklists?user_id=1&device_id=123

{
 "id": "checklist_doc_id3",
 "checklist_id": "checklist_id3",
 "values": [
 {
 "checklist_log_id": "checklist_log_id3",
 "value": "Все соответствует стандарту",
 "user_id": "user_id1",
 "step_id": "checklist_step_id2",
 "location": {
 "latitude": 55.664487,
 "longitude": 37.599175
 },
 "created_at": 12345
 }
 ],
 "repairs": [
 {
 "checklist_log_id": "checklist_log_id4",
 "repair": {
 "id": "repair_doc_id1",
 "number": "ППР-038017",
 "date": 12345, 
 "required_finish_at": 12345, 
 "user_group_ids": [
 "user_group_id1",
 "user_group_id2"
 ],
 "tasks": [
 {
 "repair_type": {
 "id": "repair_type_id1",
 "name": "Замена огнетушителей",
 "unit_group_id": "unit_group_id1",
 "checklist_ids": [
 "checklist_id1",
 "checklist_id2"
 ] 
 },
 "unit": {
 "id": "unit_id1",
 "name": "Вилочный автопогрузчик",
 "group_id": "unit_group_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "unit_attribute_id1",
 "value": "Спецтехника склада"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057000"
 }
 ] 
 },
 "node": {
 "id": "node_id1",
 "name": "Навесное оборудование погрузчика",
 "unit_id": "unit_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "node_attribute_id1",
 "value": "В эксплуатации"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057885"
 }
 ] 
 },
 "comment": "Плановый ремонт" 
 }
 ]
 }
 }
 ],
 "defects": [
 {
 "checklist_log_id": "checklist_log_id5",
 "defect": {
 "id": "doc_defect_id2",
 "user_id": "user_id1",
 "created_at": 12345,
 "type": {
 "id": "defect_type_id1",
 "name": "Нарушение в работе навесного оборудования"
 },
 "unit": {
 "id": "unit_id1",
 "name": "Вилочный автопогрузчик",
 "group_id": "unit_group_id1",
 "class_id": "class_unit_id1"
 },
 "node": {
 "id": "node_id1",
 "name": "Навесное оборудование погрузчика",
 "unit_id": "unit_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "node_attribute_id1",
 "value": "В эксплуатации"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057885"
 }
 ]
 },
 "description": "Давление в гидравлической системе ниже нормы",
 "comment": "Комментарий документа дефекта"
 }
 }
 ],
 "operate_times": [
 {
 "checklist_log_id": "checklist_log_id6",
 "operate_time": {
 "id": "doc_operate_time_id1",
 "user_id": "user_id1",
 "created_at": 12345,
 "unit_id": "unit_id1",
 "measure_id": "measure_id1",
 "node_id": "node_id1",
 "value": 1343.5 ,
 "comment": "Доп. комментариев нет",
 "location": {
 "latitude": 55.664487,
 "longitude": 37.599175
 },
 "images": [
 {
 "name": "image2.png",
 "created_at": 12345
 }
 ] 
 }
 }
 ],
 "images": [
 {
 "name": "image6.png",
 "created_at": 12345
 }
 ]
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки документа

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


{
 "is_success": true
}

см. checklist_doc_value

docs/checklists/images

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка изображений документа чек-листа

Где используется

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

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
checklist_doc_id	string	Идентификатор документа чек-листа
checklist_log_id	string	Идентификатор лога документа чек-листа
image_name	string	Наименование файла изображения
data	base64	Изображение

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/checklists/images?user_id=1&device_id=123


{
 "checklist_doc_id": "doc_checklist_id1",
 "checklist_log_id": "checklist_log_id8",
 "image_name": "image6.png",
 "data": "decoding_image_in_base64"
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки изображения

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


{
 "is_success": true
}

docs/checklists/sync

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Загрузка шапок документов чек-листов

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
docs_ids	array	Массив идентификаторов документов в ПО

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/checklists/sync?user_id=1&device_id=123


{
 "docs_ids": [
 "doc_checklist_id1",
 "doc_checklist_id2"
 ]
}

Ответ

Тело

Наименование	Тип	Описание
checklist_docs обязательное	object array	Массив объектов документа чек-листов

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

Возвращаются объекты checklist_doc


[
 {
 "id": "checklist_doc_id1",
 "number": "Утренний обход помещений",
 "date": 12345, 
 "checklist_id": "checklist_id3", 
 "unit": {
 "id": "unit_id1",
 "name": "Вилочный автопогрузчик",
 "group_id": "unit_group_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "unit_attribute_id1",
 "value": "Спецтехника склада"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057000"
 }
 ] 
 },
 "node": {
 "id": "node_id1",
 "name": "Навесное оборудование погрузчика",
 "unit_id": "unit_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "node_attribute_id1",
 "value": "В эксплуатации"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057885"
 }
 ] 
 }
 } 
]

см. checklist_doc

docs/defects

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка документа дефекта

Где используется

На форме списка документов дефектов

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
id	string	Идентификатор документа дефекта
user_id	string	Идентификатор пользователя, который выполнил документ
created_at	timestamp	Дата и время документа в timestamp
type_id	string	Идентификатор типа дефекта
unit_id	string	Идентификатор объекта эксплуатации
node_id	string	Идентификатор узла
description	string	Описание дефекта
comment	string	Комментарий документа
location	object	Объект геолокации документа
images	object array	Массив объектов изображений

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/defects?user_id=1&device_id=123


{
 "id": "doc_defect_id1",
 "user_id": "user_id1",
 "created_at": 12345,
 "type_id": "defect_type_id1",
 "unit_id": "unit_id1",
 "node_id": "node_id1",
 "description": "Отсутствуют дополнительные элементы безопасности оборудования",
 "comment": "Доп. комментариев нет",
 "location": {
 "latitude": 55.664487,
 "longitude": 37.599175
 },
 "images": [
 {
 "name": "image1.png",
 "created_at": 12345
 }
 ]
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки документа

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


{
 "is_success": true
}

см. location

docs/defects/images

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка изображений документа дефекта

Где используется

На форме списка документов дефектов

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
defect_id	string	Идентификатор документа дефекта
image_name	string	Наименование файла изображения
data	base64	Изображение

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/defects/images?user_id=1&device_id=123


{
 "defect_id": "doc_defect_id1",
 "image_name": "image1.png",
 "data": "decoding_image_in_base64"
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки изображения

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


{
 "is_success": true
}

docs/defects/sync

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Загрузка шапок документов дефектов

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
docs_ids	array	Массив идентификаторов документов в ПО

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/defects/sync?user_id=1&device_id=123


{
 "docs_ids": [
 "doc_defect_id1",
 "doc_defect_id2"
 ]
}

Ответ

Тело

Наименование	Тип	Описание
defects обязательное	object array	Массив объектов документа дефекта

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

Возвращаются объекты defect


[
 {
 "id": "doc_defect_id1",
 "user_id": "user_id1",
 "created_at": 12345,
 "type": {
 "id": "defect_type_id1",
 "name": "Нарушение в работе навесного оборудования"
 },
 "unit": {
 "id": "unit_id1",
 "name": "Вилочный автопогрузчик",
 "group_id": "unit_group_id1",
 "class_id": "class_unit_id1"
 },
 "node": {
 "id": "node_id1",
 "name": "Навесное оборудование погрузчика",
 "unit_id": "unit_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "node_attribute_id1",
 "value": "В эксплуатации"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057885"
 }
 ]
 },
 "description": "Описание дефекта",
 "comment": "Комментарий документа"
 }
]

см. defect

docs/operate_times

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка документа наработки

Где используется

На форме списка документов наработки

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
operate_time	object	Объект документа наработки

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/operate_times?user_id=1&device_id=123


{
 "id": "doc_operate_time_id1",
 "user_id": "user_id1",
 "created_at": 12345,
 "unit_id": "unit_id1",
 "measure_id": "measure_id1",
 "node_id": "node_id1",
 "value": 1343.5 ,
 "comment": "Доп. комментариев нет",
 "location": {
 "latitude": 55.664487,
 "longitude": 37.599175
 },
 "images": [
 {
 "name": "image2.png",
 "created_at": 12345
 }
 ]
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки документа

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


{
 "is_success": true
}

см. operate_time

docs/operate_times/images

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка изображений документа наработки

Где используется

На форме списка документов наработки

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
operate_time_id	string	Идентификатор документа наработки
image_name	string	Наименование файла изображения
data	base64	Изображение

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/operate_time/images?user_id=1&device_id=123


{
 "operate_time_id": "doc_operate_time_id1",
 "image_name": "image2.png",
 "data": "decoding_image_in_base64"
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки изображения

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


{
 "is_success": true
}

docs/repairs

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка документа ремонта

Где используется

На форме списка документов ремонта

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
id	string	Идентификатор документа ремонта
comment	string	Комментарий документа
user_id	string	Идентификатор пользователя, который выполнил документ
repair_type_id	string	Идентификатор типа дефекта
unit_id	string	Идентификатор объекта эксплуатации
node_id	string	Идентификатор узла
checklist_doc_id	string	Идентификатор объекта эксплуатации
checklist_log_id	string	Идентификатор узла
created_at	timestamp	Дата и время документа в timestamp
started_at	timestamp	Дата и время начала работы с документом в timestamp
finished_at	timestamp	Дата и время завершения работы над документом в timestamp
location	object	Объект геолокации документа
defect	object	Объект дефекта документа
checklist	object array	Массив объектов тех. карт документа
materials	object array	Массив объектов используемых материалов в документе
images	object array	Массив объектов изображений

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/defects?user_id=1&device_id=123


{
 "id": "doc_repair_id1",
 "comment": "Плановый ремонт",
 "user_id": "user_id1",
 "type_id": "defect_type_id1",
 "unit_id": "unit_id1",
 "node_id": "node_id1",
 "checklist_doc_id": "checklist_doc_id3",
 "checklist_log_id": "checklist_log_id4",
 "created_at": 12345,
 "started_at": 12345,
 "finished_at": 12345, 
 "location": {
 "latitude": 55.664487,
 "longitude": 37.599175
 },
 "defect": {
 "id": "doc_defect_id1",
 "user_id": "user_id1",
 "created_at": 12345,
 "type": {
 "id": "defect_type_id1",
 "name": "Нарушение в работе навесного оборудования"
 },
 "unit": {
 "id": "unit_id1",
 "name": "Вилочный автопогрузчик",
 "group_id": "unit_group_id1",
 "class_id": "class_unit_id1"
 },
 "node": {
 "id": "node_id1",
 "name": "Навесное оборудование погрузчика",
 "unit_id": "unit_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "node_attribute_id1",
 "value": "В эксплуатации"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057885"
 }
 ]
 },
 "description": "Описание дефекта",
 "comment": "Комментарий документа"
 },
 "checklist": [
 {
 "id": "checklist_id1",
 "name": "Осмотр ТС",
 "steps": [
 {
 "checklist_step_id": "checklist_step_id1",
 "position": 0
 },
 {
 "checklist_step_id": "checklist_step_id2",
 "position": 1
 }
 ]
 }
 ],
 "materials": [
 {
 "material_id": "material_id1",
 "qty": 5.0
 }
 ],
 "images": [
 {
 "name": "image4.png",
 "created_at": 12345
 }
 ]
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки документа

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


{
 "is_success": true
}

см. defect

docs/repairs/images

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка изображений документа ремонта

Где используется

На форме списка документов ремонтов

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
repair_id	string	Идентификатор документа ремонта
image_name	string	Наименование файла изображения
data	base64	Изображение

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/repairs/images?user_id=1&device_id=123


{
 "repair_id": "doc_repair_id1",
 "image_name": "image4.png",
 "data": "decoding_image_in_base64"
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки изображения

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


{
 "is_success": true
}

docs/repairs/sync

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Загрузка шапок документов ремонта

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
docs_ids	array	Массив идентификаторов документов в ПО

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


http://192.168.1.1/ERP/hs/DmToirExch/api/docs/repairs/sync?user_id=1&device_id=123


{
 "docs_ids": [
 "doc_repair_id1",
 "doc_repair_id2"
 ]
}

Ответ

Тело

Наименование	Тип	Описание
repairs обязательное	object array	Массив объектов документа ремонта

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

Возвращаются объекты repair


[
 {
 "id": "repair_doc_id1",
 "number": "ППР-038017",
 "date": 12345, 
 "required_finish_at": 12345, 
 "user_group_ids": [
 "user_group_id1",
 "user_group_id2"
 ],
 "tasks": [
 {
 "repair_type": {
 "id": "repair_type_id1",
 "name": "Замена огнетушителей",
 "unit_group_id": "unit_group_id1",
 "checklist_ids": [
 "checklist_id1",
 "checklist_id2"
 ] 
 },
 "unit": {
 "id": "unit_id1",
 "name": "Вилочный автопогрузчик",
 "group_id": "unit_group_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "unit_attribute_id1",
 "value": "Спецтехника склада"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057000"
 }
 ] 
 },
 "node": {
 "id": "node_id1",
 "name": "Навесное оборудование погрузчика",
 "unit_id": "unit_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "node_attribute_id1",
 "value": "В эксплуатации"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057885"
 }
 ] 
 },
 "comment": "Плановый ремонт" 
 }
 ]
 } 
]

см. repair

materials

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Материалы” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/materials?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
materials обязательное	object array	Массив объектов материала

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

Возвращаются объекты material


[
 {
 "id": "material_id1",
 "name": "Цилиндр огнетушителя ОП-10",
 "barcodes": [ 
 {
 "value": "2000000058761"
 }
 ]
 }
]

см. material

measures

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Единицы измерения наработки” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/measures?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
measures обязательное	object array	Массив объектов единицы измерения наработки

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

Возвращаются объекты measure


[
 {
 "id": "measure_id1",
 "name": "Часы работы"
 },
 {
 "id": "measure_id2",
 "name": "Километраж"
 }
]

см. measure

nodes

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Узлы” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/nodes?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
nodes обязательное	object array	Массив объектов узла

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

Возвращаются объекты node


[
 {
 "id": "node_id1",
 "name": "Навесное оборудование погрузчика",
 "unit_id": "unit_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "node_attribute_id1",
 "value": "В эксплуатации"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057885"
 }
 ]
 "rfids":[
 {
 "value": "A21000000000497101"
 }
 ]
 } 
]

см. node

node_attributes

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Атрибуты узлов” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/node_attributes?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
node_attributes обязательное	object array	Массив объектов атрибута узла

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

Возвращаются объекты node_attribute


[
 {
 "id": "node_attribute_id1",
 "name": "Статус"
 }
]

см. node_attribute

nodes/barcodes/list

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка новых штрихкодов узлов объектов эксплуатации

Где используется

В форме списка справочника “Объекты” в фильтре “Узлы”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
elements	object array	Массив объектов элемента списка

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


http://192.168.1.1/ERP/hs/DmToirExch/api/nodes/barcodes/list?user_id=1&device_id=123


{
 [
 {
 "id": "node_id1",
 "value": "2000000339020"
 },
 {
 "id": "node_id2",
 "value": "2000000339021"
 },
 ]
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки

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


{
 "is_success": true
}

см. element

nodes/rfids/list

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка новых RFID-меток узлов объектов эксплуатации

Где используется

В форме списка справочника “Объекты” в фильтре “Узлы”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
elements	object array	Массив объектов элемента списка

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


http://192.168.1.1/ERP/hs/DmToirExch/api/nodes/rfids/list?user_id=1&device_id=123


{
 [
 {
 "id": "node_id1",
 "value": "A21000000000493100"
 },
 {
 "id": "node_id2",
 "value": "A21000000000493101"
 },
 ]
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки

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


{
 "is_success": true
}

см. element

units

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Объекты эксплуатации” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/units?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
units обязательное	object array	Массив объектов объекта эксплуатации

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

Возвращаются объекты unit


[
 {
 "id": "unit_id1",
 "name": "Вилочный автопогрузчик",
 "group_id": "unit_group_id1",
 "class_id": "class_unit_id1",
 "attributes": [ 
 {
 "attribute_id": "unit_attribute_id1",
 "value": "Спецтехника склада"
 }
 ],
 "barcodes": [ 
 {
 "value": "2000000057000"
 }
 ]
 "rfids": [ 
 {
 "value": "E29011110000767800"
 }
 ]
 } 
]

см. unit

unit_attributes

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Атрибуты объектов” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/unit_attributes?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
unit_attributes обязательное	object array	Массив объектов атрибута объекта

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

Возвращаются объекты unit_attribute


[
 {
 "id": "unit_attribute_id1",
 "name": "Тип объекта"
 }
]

см. unit_attribute

unit_groups

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Группы объектов” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/unit_groups?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
unit_groups обязательное	object array	Массив объектов группа объекта

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

Возвращаются объекты unit_group


[
 {
 "id": "unit_group_id1",
 "name": "Автопогрузчики"
 }
]

см. unit_group

units/barcodes/list

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка новых штрихкодов объектов эксплуатации

Где используется

В форме списка справочника “Объекты” в фильтре “Объекты”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
elements	object array	Массив объектов элемента списка

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


http://192.168.1.1/ERP/hs/DmToirExch/api/units/barcodes/list?user_id=1&device_id=123


{
 [
 {
 "id": "unit_id1",
 "value": "2000000189023"
 },
 {
 "id": "unit_id2",
 "value": "2000000189024"
 },
 ]
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки

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


{
 "is_success": true
}

см. element

units/rfids/list

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Выгрузка новых RFID-меток объектов эксплуатации

Где используется

В форме списка справочника “Объекты” в фильтре “Объекты”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
elements	object array	Массив объектов элемента списка

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


http://192.168.1.1/ERP/hs/DmToirExch/api/units/rfids/list?user_id=1&device_id=123


{
 [
 {
 "id": "unit_id1",
 "value": "E29011110000339300"
 },
 {
 "id": "unit_id2",
 "value": "E29011110000339301"
 },
 ]
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус выгрузки

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


{
 "is_success": true
}

см. element

users

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Пользователи” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/users?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
users обязательное	object array	Массив объектов пользователя

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

Возвращаются объекты user


[
 {
 "id": "user_id1",
 "name": "Администратор",
 "barcode": "admin",
 "password": "pass123",
 "is_admin": true,
 "group_ids": [
 "user_group_id1",
 "user_group_id2" 
 ]
 }
]

см. user

user_groups

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Бригады” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/user_groups?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
user_groups обязательное	object array	Массив объектов бригады

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

Возвращаются объекты user_group


[
 {
 "id": "user_group_id1",
 "name": "Слесари"
 },
 {
 "id": "user_group_id2"
 "name": "Электромонтажники"
 }
]

см. user_group

repair_materials

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Связей типов ремонтов с материалами” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/repair_materials?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
repair_materials обязательное	object array	Массив объектов связи типа ремонта с материалом

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

Возвращаются объекты repair_material


[
 {
 "repair_type_id": "repair_type_id1",
 "material_id": "material_id1",
 "quantity": 5.0
 }
]

см. repair_material

repair_types

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника “Типы ремонта” в мобильное приложение

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
user_id	string	Идентификатор пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/ERP/hs/DmToirExch/api/repair_types?user_id=1&device_id=123

Ответ

Тело

Наименование	Тип	Описание
repair_types обязательное	object array	Массив объектов типа ремонта

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

Возвращаются объекты repair_type


[
 {
 "id": "repair_type_id1",
 "name": "Замена огнетушителей",
 "unit_group_id": "unit_group_id1",
 "checklist_ids": [
 "checklist_id1",
 "checklist_id2",
 ]
 }
]

см. repair_type

system/ping

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Проверка состояния соединения с сервером

Где используется

На всех формах (индикатор соединения с сервером)

Запрос

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


http://192.168.1.1/ERP/hs/DmToirExch/api/system/ping

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус соединения с сервером

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


{
 "is_success": true
}

system/version

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Проверка версии формата обмена сервера

Где используется

Авторизация
Проверка соединения
Сохранение настроек обмена

Запрос

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


http://192.168.1.1/ERP/hs/DmToirExch/api/system/version

Ответ

Тело

Наименование	Тип	Описание
data обязательное	string	Версия форматов обмена

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


{
 "data": "1.2.0"
}