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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -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**|Структура, содержащая в себе возвращаемые данные
... ... @@ -209,13 +209,29 @@
209 209  |FileName|string|Оригинальное наименование файла
210 210  |Content|base64Binary|Содержимое файла в Base64
211 211  
212 -
213 213  * (((
214 214  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
215 215  )))
216 216  
217 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
218 218  
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 +
219 219  * (((
220 220  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
221 221  )))
... ... @@ -293,7 +293,7 @@
293 293  
294 294  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
295 295  
296 -**Входные параметры:**
312 +=== **Входные параметры:** ===
297 297  
298 298  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
299 299  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -303,9 +303,9 @@
303 303  
304 304  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
305 305  
306 -**Выходные параметры:**
322 +=== **Выходные параметры:** ===
307 307  
308 -**Секция Tracking**
324 +=== **Секция Tracking** ===
309 309  
310 310  |Название параметра|Тип параметра|Описание параметра|Пример
311 311  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -397,8 +397,10 @@
397 397  |IMEI4NEW|**string (255)**|IMEI4 новый|
398 398  |RepairLevel|**string (300)**|Уровень ремонта|
399 399  
400 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
416 +=== Подсекция Parts секции Tracking ===
401 401  
418 +состоит из коллекции типа PartRecord следующего формата:
419 +
402 402  |Название параметра|Тип параметра|Описание параметра|Пример
403 403  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
404 404  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -435,7 +435,7 @@
435 435  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
436 436  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
437 437  
438 -**Секция Payment**
456 +=== Секция Payment ===
439 439  
440 440  |Название параметра|Тип параметра|Описание параметра|Пример
441 441  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -460,13 +460,15 @@
460 460  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
461 461  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
462 462  
463 -**Отдельный параметр**
481 +=== Ссылка на ремонт ===
464 464  
465 465  |Название параметра|Тип параметра|Описание параметра|Пример
466 466  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
467 467  
468 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
486 +=== Секция ValidationErrors ===
469 469  
488 +содержит коллекцию ErrorItem следующего вида:
489 +
470 470  |Название параметра|Тип параметра|Описание параметра|Пример
471 471  |ErrorCode|**string**|Код ошибки|43
472 472  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -479,7 +479,7 @@
479 479  
480 480  Возвращает трекинг по системному номеру (OrderNum).
481 481  
482 -**Входные параметры:**
502 +=== **Входные параметры:** ===
483 483  
484 484  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
485 485  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -489,9 +489,9 @@
489 489  
490 490  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
491 491  
492 -**Выходные параметры:**
512 +=== **Выходные параметры:** ===
493 493  
494 -**Секция Tracking**
514 +=== **Секция Tracking** ===
495 495  
496 496  |Название параметра|Тип параметра|Описание параметра|Пример
497 497  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -583,8 +583,10 @@
583 583  |IMEI4NEW|**string (255)**|IMEI4 новый|
584 584  |RepairLevel|**string (300)**|Уровень ремонта|
585 585  
586 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
606 +=== Подсекция Parts секции Tracking ===
587 587  
608 +состоит из коллекции типа PartRecord следующего формата:
609 +
588 588  |Название параметра|Тип параметра|Описание параметра|Пример
589 589  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
590 590  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -621,7 +621,7 @@
621 621  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
622 622  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
623 623  
624 -**Секция Payment**
646 +=== Секция Payment ===
625 625  
626 626  |Название параметра|Тип параметра|Описание параметра|Пример
627 627  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -646,13 +646,15 @@
646 646  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
647 647  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
648 648  
649 -**Отдельный параметр**
671 +=== Ссылка на ремонт ===
650 650  
651 651  |Название параметра|Тип параметра|Описание параметра|Пример
652 652  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
653 653  
654 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
676 +=== Секция ValidationErrors ===
655 655  
678 +содержит коллекцию ErrorItem следующего вида:
679 +
656 656  |Название параметра|Тип параметра|Описание параметра|Пример
657 657  |ErrorCode|**string**|Код ошибки|43
658 658  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -665,12 +665,12 @@
665 665  
666 666  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
667 667  
668 -Входные параметры:
692 +=== Входные параметры: ===
669 669  
670 670  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
671 671  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
672 672  
673 -Выходные параметры:
697 +=== Выходные параметры: ===
674 674  
675 675  Возвращает коллекцию TrackingShortItem следующего вида:
676 676  
... ... @@ -798,6 +798,8 @@
798 798  )))|Added
799 799  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
800 800  
825 +=== Ошибки при сохранении ремонта ===
826 +
801 801  Секция Errors содержит коллекцию строк ошибок.
802 802  
803 803  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: