public/eurostyle-server-api-requirements
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add service orders to API

Browse Source
This commit is contained in:
Галиев Руслан
2025-06-26 13:46:37 +03:00
parent 04af31e793
commit 9dd7fd1629
1 changed files with 145 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
eurostyle-server-api-requirements.md
View File

@ -75,6 +75,8 @@
"brand_key": "brand-001",
"customer_key": "cust-001",
"master_key": "master-001",
"serviced_from": "2025-01-01",
"serviced_by": "2025-12-01",
"comment": "Пункт обслуживания"
}
]
@ -87,6 +89,8 @@
| `brand_key` | string | ✅ | Связь с брендом |
| `customer_key` | string | ✅ | Связь с клиентом |
| `master_key` | string | ✅| Прикреплённый мастер |
| `serviced_from` | date | ❌ | Дата начала сервисного обслуживания |
| `serviced_by` | date | ❌ | Дата завершения сервисного обслуживания |
| `comment` | string | ❌ | Комментарий |
---
@ -800,6 +804,147 @@ part_type - Перечисление (Enum)
---
### ✅ `GET /api/v1/service_orders`
Описание: Ответ содержит массив из хешей содержащих 1С ключей документов планового ТО
Доступные параметры
| Параметр | Назначение |
|------------|--------------------------|
| `start_date` | Фильтр по дате документа(начинается от) |
| `end_date` | Фильтр по дате документа(заканчивается до) |
```json
[
{
"external_key": "so-001"
},
{
"external_key": "so-002"
},
{
"external_key": "so-003"
}
]
```
---
### ✅ `GET /api/v1/service_orders/so-001`
Описание: Ответ содержит конкретный документ "Планового ТО"
```json
{
"external_key": "key-1",
"status": 0,
"number_in_client_database": "Номер в базе клиента",
"number": "1234",
"date": "2025-06-01 10:00:00",
"address_key": "address-key",
"date_of_service": "2025-06-01 10:00:00",
"responsible": "Отвественный/(строка)",
"conclusion": "Заключение",
"comment": "Комментарий",
"masters": [
{
"master_key": "master-key1"
},
{
"master_key": "master-key2"
}
]
}
```
Описание полей:
| Поле | Тип | Обязательно | Описание |
|-----------------------------|----------|-------------|----------------------------------------|
| `external_key` | string | ✅ | Уникальный ID заявки |
| `address_key` | string | ✅ | Ссылка на адрес |
| `number` | string | ✅ | Номер документа |
| `date` | datetime | ✅ | Дата документа. |
| `number_in_client_database` | string | ❌ | Номер в базе клиента |
| `date_of_service` | datetime | ✅ | Дата проведения ТО |
| `responsible` | string | ❌ | Ответственный |
| `status` | numeric | ✅ | Статус. (enum) |
| `comment.`. | text | ❌ | Комментарий. |
| `conclusion` | text | ❌ | Заключение |
state - Перечисление (Enum)
| Значение | Описание |
|----------|-------------------------|
| `0` | Новая |
| `1` | В работе |
| `2` | Завершено |
| `3` | Плановая |
| `4` | Нет акта |
| `5` | Уточнение |
| `6` | Ремонт в мастерской. |
| `7` | Непринятая |
| `8` | Отклонена |
---
### ✅ `POST /api/v1/service_orders`
Создание нового документа "Планового ТО".
**Тело запроса:**
```json
{
"number_in_client_database": "Номер в базе клиента",
"address_key": "address-key",
"date_of_service": "2025-06-01 10:00:00",
"conclusion": "Заключение",
"comment": "Комментарий",
"masters": [
{
"master_key": "master-key1"
},
{
"master_key": "master-key2"
}
]
}
```
Ответ соответствует ответу при запросе конкретного документа "Планового ТО"
---
### ✅ `PUT /api/v1/service_orders/so-001`
Обновление документа "Планового ТО".
**Тело запроса:**
```json
{
"number_in_client_database": "Номер в базе клиента",
"address_key": "address-key",
"date_of_service": "2025-06-01 10:00:00",
"conclusion": "Заключение",
"comment": "Комментарий",
"masters": [
{
"master_key": "master-key1"
},
{
"master_key": "master-key2"
}
]
}
```
Ответ соответствует ответу при запросе конкретного документа "Планового ТО"
---
## 🔄 Поддержка изменений
Во всех API справочников , а также в API получения списка заявок