Изменения документа Интеграция с трекингом (API)

Редактировал(а) Дмитрий Семёнов 2025/04/10 15:52
От версии < 24.1 >
отредактировано Дмитрий Семёнов
на 2025/03/28 16:01
К версии < 30.2 >
отредактировано Дмитрий Семёнов
на 2025/04/10 15:51
< >
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -96,7 +96,7 @@
96 96  
97 97  Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
98 98  
99 -== Входные параметры ==
99 +=== Входные параметры ===
100 100  
101 101  |Название параметра|Тип параметра|Обяз.|Описание параметра
102 102  |ticket|string|Да|Сессионный ключ
... ... @@ -104,7 +104,7 @@
104 104  |trackingId|string|Нет|Номер ремонта (ETxxxxxxx)
105 105  |trackingUid|guid|Нет|GUID ремонта (b63f5255-198d-46d6-aaa5-9f9255f3de9b)
106 106  
107 -== Возвращаемое значение ==
107 +=== Возвращаемое значение ===
108 108  
109 109  |**Название параметра**|**Тип параметра**|**Описание параметра**
110 110  |GetANRPInfoResult|**record**|Структура, содержащая в себе возвращаемые данные
... ... @@ -132,7 +132,7 @@
132 132  
133 133  Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
134 134  
135 -== Входные параметры ==
135 +=== Входные параметры ===
136 136  
137 137  |Название параметра|Тип параметра|Обяз.|Описание параметра
138 138  |ticket|string|Да|Сессионный ключ
... ... @@ -140,7 +140,7 @@
140 140  |trackingId|string|Нет|Номер ремонта (ETxxxxxxx)
141 141  |trackingUid|guid|Нет|GUID ремонта (b63f5255-198d-46d6-aaa5-9f9255f3de9b)
142 142  
143 -== Возвращаемое значение ==
143 +=== Возвращаемое значение ===
144 144  
145 145  |**Название параметра**|**Тип параметра**|**Описание параметра**
146 146  |GetATOInfoResult|**record**|Структура, содержащая в себе возвращаемые данные
... ... @@ -168,7 +168,7 @@
168 168  
169 169  Возвращает справочник мест ремонта.
170 170  
171 -== Входные параметры ==
171 +=== Входные параметры ===
172 172  
173 173  |Название параметра|Тип параметра|Обяз.|Описание параметра
174 174  |ticket|string|Да|Сессионный ключ
... ... @@ -175,7 +175,7 @@
175 175  |MainBrandUid|string|Да|GUID группы брендов
176 176  |Version|string|Нет|Версия протокола (1.0)
177 177  
178 -== Возвращаемое значение ==
178 +=== Возвращаемое значение ===
179 179  
180 180  |**Название параметра**|**Тип параметра**|**Описание параметра**
181 181  |GetActionPlaceResult|**record**|Структура, содержащая в себе возвращаемые данные в записях RefItem
... ... @@ -191,7 +191,7 @@
191 191  
192 192  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
193 193  
194 -== Входные параметры ==
194 +=== Входные параметры ===
195 195  
196 196  |Название параметра|Тип параметра|Обяз.|Описание параметра
197 197  |message.ticket|string|Да|Сессионный ключ
... ... @@ -199,7 +199,7 @@
199 199  |numberKey|string|Да|Номер ремонта АСЦ
200 200  |typeUid|guid|Да|Идентификатор типа вложения
201 201  
202 -== Возвращаемое значение ==
202 +=== Возвращаемое значение ===
203 203  
204 204  |**Название параметра**|**Тип параметра**|**Описание параметра**
205 205  |GetAttachmentResult|**record**|Структура, содержащая в себе возвращаемые данные
... ... @@ -213,8 +213,25 @@
213 213  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
214 214  )))
215 215  
216 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
217 217  
218 +=== Входные параметры ===
219 +
220 +|Название параметра|Тип параметра|Обяз.|Описание параметра
221 +|message.ticket|string|Да|Сессионный ключ
222 +|message.Version|string|Нет|Версия протокола (1.0)
223 +|numberKey|string|Да|Номер ремонта АСЦ (ETxxxxxxx)
224 +
225 +=== Возвращаемое значение ===
226 +
227 +|**Название параметра**|**Тип параметра**|**Описание параметра**
228 +|GetAttachmentKeysResult|**record**|Структура, содержащая в себе возвращаемые данные в виде списка объектов AttachmentKeyItem
229 +|(% colspan="3" %)**Структура GetAttachmentKeysResult**
230 +|TrackingUid|guid| GUID ремонта
231 +|AttachmentType|guid|Идентификатор типа ремонта
232 +|FileName|string|Оригинальное наименование файла
233 +|Lenght|int|Длина файла
234 +
218 218  * (((
219 219  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
220 220  )))
... ... @@ -221,6 +221,22 @@
221 221  
222 222  Возвращает список типов вложений
223 223  
241 +=== Входные параметры ===
242 +
243 +|Название параметра|Тип параметра|Обяз.|Описание параметра
244 +|message.ticket|string|Да|Сессионный ключ
245 +|message.Version|string|Нет|Версия протокола (1.0)
246 +|MainBrandUid|GUID|Да|Идентификатор бренда
247 +
248 +=== Возвращаемое значение ===
249 +
250 +|**Название параметра**|**Тип параметра**|**Описание параметра**
251 +|GetAttachmentTypesResult|**record**|Структура, содержащая в себе возвращаемые данные в виде списка объектов RefItem
252 +|(% colspan="3" %)**Структура RefItem**
253 +|Uid|guid| GUID типа вложения
254 +|Name|string|Наименование типа вложения
255 +|ID|int|Индекс типа вложения (на данный момент не используется)
256 +
224 224  * (((
225 225  == [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]] ==
226 226  )))
... ... @@ -292,7 +292,7 @@
292 292  
293 293  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
294 294  
295 -**Входные параметры:**
328 +=== **Входные параметры:** ===
296 296  
297 297  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
298 298  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -302,9 +302,9 @@
302 302  
303 303  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
304 304  
305 -**Выходные параметры:**
338 +=== **Выходные параметры:** ===
306 306  
307 -**Секция Tracking**
340 +=== **Секция Tracking** ===
308 308  
309 309  |Название параметра|Тип параметра|Описание параметра|Пример
310 310  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -396,8 +396,10 @@
396 396  |IMEI4NEW|**string (255)**|IMEI4 новый|
397 397  |RepairLevel|**string (300)**|Уровень ремонта|
398 398  
399 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
432 +=== Подсекция Parts секции Tracking ===
400 400  
434 +состоит из коллекции типа PartRecord следующего формата:
435 +
401 401  |Название параметра|Тип параметра|Описание параметра|Пример
402 402  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
403 403  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -434,7 +434,7 @@
434 434  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
435 435  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
436 436  
437 -**Секция Payment**
472 +=== Секция Payment ===
438 438  
439 439  |Название параметра|Тип параметра|Описание параметра|Пример
440 440  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -459,13 +459,15 @@
459 459  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
460 460  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
461 461  
462 -**Отдельный параметр**
497 +=== Ссылка на ремонт ===
463 463  
464 464  |Название параметра|Тип параметра|Описание параметра|Пример
465 465  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
466 466  
467 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
502 +=== Секция ValidationErrors ===
468 468  
504 +содержит коллекцию ErrorItem следующего вида:
505 +
469 469  |Название параметра|Тип параметра|Описание параметра|Пример
470 470  |ErrorCode|**string**|Код ошибки|43
471 471  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -478,7 +478,7 @@
478 478  
479 479  Возвращает трекинг по системному номеру (OrderNum).
480 480  
481 -**Входные параметры:**
518 +=== **Входные параметры:** ===
482 482  
483 483  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
484 484  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -488,9 +488,9 @@
488 488  
489 489  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
490 490  
491 -**Выходные параметры:**
528 +=== **Выходные параметры:** ===
492 492  
493 -**Секция Tracking**
530 +=== **Секция Tracking** ===
494 494  
495 495  |Название параметра|Тип параметра|Описание параметра|Пример
496 496  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -582,8 +582,10 @@
582 582  |IMEI4NEW|**string (255)**|IMEI4 новый|
583 583  |RepairLevel|**string (300)**|Уровень ремонта|
584 584  
585 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
622 +=== Подсекция Parts секции Tracking ===
586 586  
624 +состоит из коллекции типа PartRecord следующего формата:
625 +
587 587  |Название параметра|Тип параметра|Описание параметра|Пример
588 588  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
589 589  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -620,7 +620,7 @@
620 620  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
621 621  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
622 622  
623 -**Секция Payment**
662 +=== Секция Payment ===
624 624  
625 625  |Название параметра|Тип параметра|Описание параметра|Пример
626 626  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -645,13 +645,15 @@
645 645  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
646 646  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
647 647  
648 -**Отдельный параметр**
687 +=== Ссылка на ремонт ===
649 649  
650 650  |Название параметра|Тип параметра|Описание параметра|Пример
651 651  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
652 652  
653 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
692 +=== Секция ValidationErrors ===
654 654  
694 +содержит коллекцию ErrorItem следующего вида:
695 +
655 655  |Название параметра|Тип параметра|Описание параметра|Пример
656 656  |ErrorCode|**string**|Код ошибки|43
657 657  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -664,12 +664,12 @@
664 664  
665 665  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
666 666  
667 -Входные параметры:
708 +=== Входные параметры: ===
668 668  
669 669  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
670 670  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
671 671  
672 -Выходные параметры:
713 +=== Выходные параметры: ===
673 673  
674 674  Возвращает коллекцию TrackingShortItem следующего вида:
675 675  
... ... @@ -797,6 +797,8 @@
797 797  )))|Added
798 798  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
799 799  
841 +=== Ошибки при сохранении ремонта ===
842 +
800 800  Секция Errors содержит коллекцию строк ошибок.
801 801  
802 802  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: