¶ Для работы с блоком ТО из CRUD-методов доступны:
¶ Интервалы:
- GET - http://sputnic.tech/mobile_api/interval (Получить все интервалы пользователя)
| Название параметра | Определение |
| name | название интервала |
| user | id клиента создавшего интервал |
| warning |
объект, в котором по каждой метрике ТО (пробег, моточасы, дата) указано значение предупреждения |
| interval |
объект, в котором по каждой метрике ТО (пробег, моточасы, дата) указано значение интервала |
| type | объект, в котором указано по каким метрикам работает интервал. |
| id | id интервала |
| description | описание интервала |
2. POST - http://sputnic.tech/mobile_api/interval (Создать интервал)
curl --location 'https://sputnic.tech/mobile_api/interval' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE3NDY0MjIzMjgsImV4cCI6MTc0NjQ1ODMyOCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sImxvZ2luIjoiNDU3ODk5IiwiaWQiOjI1fQ.-HK25NfOPV3DJ-AUJEMqeJ7kVmUd9FUhI1S9OC_i18E9HN_O9pombLjP_t1vMq0BBc6POrhfzxt6JZRCmzrNnA' \
--header 'Cookie: PHPSESSID=2cfpidg93c88hd0q9sbcvljnbi' \
--data '{
"name": "Test postman new from mobile API",
"description": "description",
"warning": {
"mileage": 10,
"motohours": 10,
"date": 2
},
"interval": {
"mileage": 200,
"motohours": 200,
"date": 10
},
"type":{
"mileage": true,
"motohours": true,
"date": true
}
}'В ответе придут все интервалы пользователя.
При создании интервала пользователь выбирает по каким метрикам производить отслеживание. По пробегу - mileage, по моточасам - motohours, по дате(в кол-ве дней) - date. Для выбранных метрик открываются поля для ввода значений.
3. PATCH - http://sputnic.tech/mobile_api/interval /{id интерала} (Обновить интервал)
curl --location --globoff --request PATCH 'https://sputnic_dev.tech/new_api/interval/{id}' \
--header 'Content-Type: application/json' \
--header 'Cookie: PHPSESSID=2cfpidg93c88hd0q9sbcvljnbi' \
--data '{
"name": "Новый отредактированный интервал",
"description": "Новое описание",
"warning": {
"mileage": 2,
"motohours": 2
},
"interval": {
"mileage": 3,
"motohours": 3
},
"type":{
"mileage": true,
"motohours": true,
"date": false
}
}'В ответе придут все интервалы пользователя.
4. DELETE - http://sputnic.tech/mobile_api/interval /{id интерала} (Удалить интервал)
В ответе придут все интервалы пользователя.
¶ Сервисы:
- GET - http://sputnic.tech/mobile_api/services (Получить все сервисы пользователя)
GET - http://sputnic.tech/mobile_api/{id объекта}/services (Получить все сервисы определенного объекта)
| Параметр | Определение |
| id | id интервала |
| id_dev | id объекта, к которому относится сервис |
| dev_name | название объекта, к которому относится сервис |
| dev_group | группа, к которой принадлежит объект, к которому относится сервис |
| interval_id | id интервала, к которому относится сервис |
| interval_name | Название интервала, к которому относится сервис |
| interval_type | Объект, в котором указано по каким метрикам работает интервал. |
| interval |
Объект, в котором по каждой метрике ТО (пробег, моточасы, дата) указано значение интервала. |
| is_message_sent | Отправлено ли сообщение о необходимости ТО |
| warning_is_been | Отправлено ли сообщение о скором ТО |
| value_remains_mileage | Кол-во километров до следующего ТО |
| value_remains_motohours | Кол-во моточасов до следующего ТО |
| value_remains_date | Кол-во дней до следующего ТО |
| motohours | Текущее значение моточасов объекта |
| mileage | Текущее значение пробега объекта |
2. POST - http://sputnic.tech/mobile_api/services/create (Создает сервисы)
curl --location 'https://sputnic.tech/new_api/services/create' \
--header 'Content-Type: application/json' \
--header 'Cookie: PHPSESSID=2cfpidg93c88hd0q9sbcvljnbi' \
--data '{
"devices": [310,308],
"intervals": [1,2,3]
}'На входе ожидает два массива:
- devices - идентификаторы объектов, для которых создаются сервисы
- intervals - идентификаторы интервалов, на которые создаются сервисы
В ответе придут все сервисы данного пользователя.
3. PATCH http://sputnic.tech/mobile_api/services/{id сервиса} (Обновляет сервис)*
curl --location --request PATCH 'https://sputnic.tech/new_api/services/{ид сервиса}' \
--header 'Content-Type: application/json' \
--header 'Cookie: PHPSESSID=2cfpidg93c88hd0q9sbcvljnbi' \
--data '{
"price": 7766,
"manuallyValueMileage": 518787,
"manuallyValueMotohours": 9444,
"manuallyValueDate": "2025-01-29T23:59",
"changes": "foo",
"note": "bar",
"customDate": "2025-01-29T23:59",
"done": true
}'На входе ожидает параметры:
- done - отметить выполнение сервиса, bool
- price - стоимость обслуживания, int
- note - заметка к обслуживанию, string
- changes - что было поменяно в ходе ТО, string
- manuallyValueMilage - пробег, на котором было проведено техническое обслуживание, число|(Либо текущее значение пробега).
- manuallyValueMotohours - моточасы, на которых было проведено техническое обслуживание, число|(Либо текущее значение моточасов).
- manuallyValueDate - дата, в которую было проведено техническое обслуживание, строка с датой|(Либо текущая дата время).
- customDate - дата, в которую было проведено техническое обслуживание, строка|null.
*Чтобы система засчитала, что ТО было пройдено, нужно обязательно указать done = true. В таком случае сервис обновится, а данные о его прохождении появятся в истории ТО
4. DELETE http://sputnic.tech/mobile_api/services/{id сервиса} (Удаляет сервис)
Удаляет сервис. В ответе придут все сервисы данного пользователя.
¶ История ТО
- GET https://sputnic.tech/mobile_api/logServicesCount?date_from={Дата ОТ}&date_to={Дата ДО}
(Присылает количество записей по истории ТО пользователя за выбранный промежуток - для пагинации)
- GET https://sputnic.tech/mobile_api/logServices?date_from={Дата}&date_to={Дата}&field=datetime&order={desc/asc} (Присылает историю ТО всех машин пользователя)
GET- параметры:
| Параметр | Определение |
| id | ид записи |
| id_dev | идентификатор объекта, по которому сделана запись |
| dev_name | название объекта, по которому сделана запись |
| id_interval | идентификатор интервала, по которому сделана запись |
| interval_name | название интервала, по которому сделана запись |
| expected |
объект, на каком значении (зависит от типа) ожидалось обслуживание по всем метрикам |
| actually |
объект, на каком значении (зависит от типа) произошло на самом деле по всем метрикам |
| note | заметки к ТО |
| price | стоимость обслуживания |
| changes | что было заменено в объекте |
| datetime | дата обслуживания |
| type* |
объект, в котором указано по каким метрикам работает интервал сервиса |
| mileage | пробег на момент проведения ТО |
| motohours | моточасы на момент проведения ТО |
| apipath | *Не обращать внимание, используется в веб-версии |
- Если type пришел в виде объекта {"custom": true}, то это значит, что пользователь добавил ремонт вручную, без сервисов