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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -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,12 +191,47 @@
191 191  
192 192  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
193 193  
194 +=== Входные параметры ===
195 +
196 +|Название параметра|Тип параметра|Обяз.|Описание параметра
197 +|message.ticket|string|Да|Сессионный ключ
198 +|message.Version|string|Нет|Версия протокола (1.0)
199 +|numberKey|string|Да|Номер ремонта АСЦ
200 +|typeUid|guid|Да|Идентификатор типа вложения
201 +
202 +=== Возвращаемое значение ===
203 +
204 +|**Название параметра**|**Тип параметра**|**Описание параметра**
205 +|GetAttachmentResult|**record**|Структура, содержащая в себе возвращаемые данные
206 +|(% colspan="3" %)**Структура GetAttachmentResult**
207 +|TrackingUid|guid| GUID ремонта
208 +|AttachmentType|guid|Идентификатор типа ремонта
209 +|FileName|string|Оригинальное наименование файла
210 +|Content|base64Binary|Содержимое файла в Base64
211 +
194 194  * (((
195 195  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
196 196  )))
197 197  
198 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
199 199  
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 +
200 200  * (((
201 201  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
202 202  )))
... ... @@ -203,6 +203,22 @@
203 203  
204 204  Возвращает список типов вложений
205 205  
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 +
206 206  * (((
207 207  == [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]] ==
208 208  )))
... ... @@ -209,7 +209,7 @@
209 209  
210 210  Возвращает список брендов в разрезе групп брендов.
211 211  
212 -**Входные параметры:**
263 +=== Входные параметры: ===
213 213  
214 214  Секция message
215 215  
... ... @@ -216,7 +216,7 @@
216 216  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
217 217  |ticket|**string**|Да|Сессионный ключ|Vasya
218 218  
219 -**Выходные параметры:**
270 +=== Возвращаемое значение: ===
220 220  
221 221  Возвращает коллекцию BrandItem следующего вида:
222 222  
... ... @@ -274,7 +274,7 @@
274 274  
275 275  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
276 276  
277 -**Входные параметры:**
328 +=== **Входные параметры:** ===
278 278  
279 279  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
280 280  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -284,9 +284,9 @@
284 284  
285 285  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
286 286  
287 -**Выходные параметры:**
338 +=== **Выходные параметры:** ===
288 288  
289 -**Секция Tracking**
340 +=== **Секция Tracking** ===
290 290  
291 291  |Название параметра|Тип параметра|Описание параметра|Пример
292 292  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -378,8 +378,10 @@
378 378  |IMEI4NEW|**string (255)**|IMEI4 новый|
379 379  |RepairLevel|**string (300)**|Уровень ремонта|
380 380  
381 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
432 +=== Подсекция Parts секции Tracking ===
382 382  
434 +состоит из коллекции типа PartRecord следующего формата:
435 +
383 383  |Название параметра|Тип параметра|Описание параметра|Пример
384 384  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
385 385  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -416,7 +416,7 @@
416 416  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
417 417  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
418 418  
419 -**Секция Payment**
472 +=== Секция Payment ===
420 420  
421 421  |Название параметра|Тип параметра|Описание параметра|Пример
422 422  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -441,13 +441,15 @@
441 441  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
442 442  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
443 443  
444 -**Отдельный параметр**
497 +=== Ссылка на ремонт ===
445 445  
446 446  |Название параметра|Тип параметра|Описание параметра|Пример
447 447  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
448 448  
449 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
502 +=== Секция ValidationErrors ===
450 450  
504 +содержит коллекцию ErrorItem следующего вида:
505 +
451 451  |Название параметра|Тип параметра|Описание параметра|Пример
452 452  |ErrorCode|**string**|Код ошибки|43
453 453  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -460,7 +460,7 @@
460 460  
461 461  Возвращает трекинг по системному номеру (OrderNum).
462 462  
463 -**Входные параметры:**
518 +=== **Входные параметры:** ===
464 464  
465 465  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
466 466  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -470,9 +470,9 @@
470 470  
471 471  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
472 472  
473 -**Выходные параметры:**
528 +=== **Выходные параметры:** ===
474 474  
475 -**Секция Tracking**
530 +=== **Секция Tracking** ===
476 476  
477 477  |Название параметра|Тип параметра|Описание параметра|Пример
478 478  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -564,8 +564,10 @@
564 564  |IMEI4NEW|**string (255)**|IMEI4 новый|
565 565  |RepairLevel|**string (300)**|Уровень ремонта|
566 566  
567 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
622 +=== Подсекция Parts секции Tracking ===
568 568  
624 +состоит из коллекции типа PartRecord следующего формата:
625 +
569 569  |Название параметра|Тип параметра|Описание параметра|Пример
570 570  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
571 571  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -602,7 +602,7 @@
602 602  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
603 603  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
604 604  
605 -**Секция Payment**
662 +=== Секция Payment ===
606 606  
607 607  |Название параметра|Тип параметра|Описание параметра|Пример
608 608  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -627,13 +627,15 @@
627 627  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
628 628  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
629 629  
630 -**Отдельный параметр**
687 +=== Ссылка на ремонт ===
631 631  
632 632  |Название параметра|Тип параметра|Описание параметра|Пример
633 633  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
634 634  
635 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
692 +=== Секция ValidationErrors ===
636 636  
694 +содержит коллекцию ErrorItem следующего вида:
695 +
637 637  |Название параметра|Тип параметра|Описание параметра|Пример
638 638  |ErrorCode|**string**|Код ошибки|43
639 639  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -646,12 +646,12 @@
646 646  
647 647  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
648 648  
649 -Входные параметры:
708 +=== Входные параметры: ===
650 650  
651 651  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
652 652  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
653 653  
654 -Выходные параметры:
713 +=== Выходные параметры: ===
655 655  
656 656  Возвращает коллекцию TrackingShortItem следующего вида:
657 657  
... ... @@ -779,6 +779,8 @@
779 779  )))|Added
780 780  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
781 781  
841 +=== Ошибки при сохранении ремонта ===
842 +
782 782  Секция Errors содержит коллекцию строк ошибок.
783 783  
784 784  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: