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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -26,6 +26,7 @@
26 26  |DesRepair|**string (3000)**|Нет|Заявленная неисправность
27 27  |RepairTypeUid|**guid**|Нет|(((
28 28  Тип ремонта  (связь с брендами (Default)). Значение берется из метода [[GetSpRepairTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]]. Если не заполнено, то подставится «Клиентский гарантийный».
29 +
29 29  
30 30  )))
31 31  |BrandUid|**guid**|Да|Бренд (торговая марка). Значение берётся из [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]].BrandUid
... ... @@ -56,20 +56,20 @@
56 56  |Result|**Added** or **Changed** or **NotFound** or **Error** or **Unknown**|(((
57 57  Результат выполнения операции:
58 58  
59 -+ Added – трекинг создан и помещён в базу
60 -+ Changed – трекинг изменён
61 -+ NotFound – трекинг не найден по uid
62 -+ Error – ошибка в работе метода
63 -+ Unknown – неизвестная ошибка
60 +Added – трекинг создан и помещён в базу
61 +
62 +Changed – трекинг изменён
63 +
64 +NotFound – трекинг не найден по uid
65 +
66 +Error – ошибка в работе метода
67 +
68 +Unknown – неизвестная ошибка
64 64  )))|Added
65 65  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
66 66  
67 -=== Сообщения об ошибках ===
68 -
69 69  Секция Errors содержит коллекцию строк ошибок.
70 70  
71 -=== Сообщения о валидационных проверках ===
72 -
73 73  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
74 74  
75 75  |Название параметра|Тип параметра|Описание параметра|Пример
... ... @@ -78,90 +78,28 @@
78 78  |Status|**string**|Статус трекинга|
79 79  |Descriptilon|**string**|Описание ошибки
80 80  
82 +* (((
81 81  == [[DeleteAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] ==
84 +)))
82 82  
83 83  Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
84 84  
85 85  === Входные параметры ===
86 86  
87 -|Название параметра|Тип параметра|Описание параметра|Пример
88 -|numberKey|string|Идентификатор вложения|
89 -|typeUid|string|Идентификатор типа вложения (GUID)| |
90 -
91 91  === Выходные параметры ===
92 92  
93 -Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции
94 -
92 +* (((
95 95  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
94 +)))
96 96  
97 -Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
96 +Получение информации по акту неремонтопригодности.
98 98  
99 -=== Входные параметры ===
100 -
101 -|Название параметра|Тип параметра|Обяз.|Описание параметра
102 -|ticket|string|Да|Сессионный ключ
103 -|actID|string|Нет|Номер АНРП (NSExxxxx)
104 -|trackingId|string|Нет|Номер ремонта (ETxxxxxxx)
105 -|trackingUid|guid|Нет|GUID ремонта (b63f5255-198d-46d6-aaa5-9f9255f3de9b)
106 -
107 -=== Возвращаемое значение ===
108 -
109 -|**Название параметра**|**Тип параметра**|**Описание параметра**
110 -|GetANRPInfoResult|**record**|Структура, содержащая в себе возвращаемые данные
111 -|(% colspan="3" %)**Структура GetANRPInfoResult**
112 -|ASCCodeNoSystem| |(не используется)
113 -|uid|guid|GUID акта
114 -|ActId|string|Номер акта
115 -|CreateDate|dateTime|Дата создания
116 -|ApprovalDate|dateTime|Дата утверждения акта (если он утверждён)
117 -|Brand|string|Бренд
118 -|BrandUid|guid|GUID бренда
119 -|Model|string|Наименование модели
120 -|SerialNumber|string|Серийный номер аппарата (если предусмотрен)
121 -|TrackingId|string|Номер трекинга
122 -|TrackingId|guid|GUID трекинга
123 -|ASCCode|string|Код АСЦ
124 -|ASCName|string|Наименование АСЦ
125 -|ASCCity|string|Город АСЦ
126 -|isApproved|boolean|Утверждён ли акт?
127 -|ErrorText|string|Сообщение об ошибке в акте
128 -
129 129  * (((
130 130  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
131 131  )))
132 132  
133 -Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
102 +Получение информации по акту технического освидетельствования.
134 134  
135 -=== Входные параметры ===
136 -
137 -|Название параметра|Тип параметра|Обяз.|Описание параметра
138 -|ticket|string|Да|Сессионный ключ
139 -|actID|string|Нет|Номер АНРП (NSExxxxx)
140 -|trackingId|string|Нет|Номер ремонта (ETxxxxxxx)
141 -|trackingUid|guid|Нет|GUID ремонта (b63f5255-198d-46d6-aaa5-9f9255f3de9b)
142 -
143 -=== Возвращаемое значение ===
144 -
145 -|**Название параметра**|**Тип параметра**|**Описание параметра**
146 -|GetATOInfoResult|**record**|Структура, содержащая в себе возвращаемые данные
147 -|(% colspan="3" %)**Структура GetATOInfoResult**
148 -|Conclusion|string|Код заключения по акту (NFF)
149 -|uid|guid|GUID акта
150 -|ActId|string|Номер акта
151 -|CreateDate|dateTime|Дата создания
152 -|ApprovalDate|dateTime|Дата утверждения акта (если он утверждён)
153 -|Brand|string|Бренд
154 -|BrandUid|guid|GUID бренда
155 -|Model|string|Наименование модели
156 -|SerialNumber|string|Серийный номер аппарата (если предусмотрен)
157 -|TrackingId|string|Номер трекинга
158 -|TrackingId|guid|GUID трекинга
159 -|ASCCode|string|Код АСЦ
160 -|ASCName|string|Наименование АСЦ
161 -|ASCCity|string|Город АСЦ
162 -|isApproved|boolean|Утверждён ли акт?
163 -|ErrorText|string|Сообщение об ошибке в акте
164 -
165 165  * (((
166 166  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
167 167  )))
... ... @@ -168,23 +168,6 @@
168 168  
169 169  Возвращает справочник мест ремонта.
170 170  
171 -=== Входные параметры ===
172 -
173 -|Название параметра|Тип параметра|Обяз.|Описание параметра
174 -|ticket|string|Да|Сессионный ключ
175 -|MainBrandUid|string|Да|GUID группы брендов
176 -|Version|string|Нет|Версия протокола (1.0)
177 -
178 -=== Возвращаемое значение ===
179 -
180 -|**Название параметра**|**Тип параметра**|**Описание параметра**
181 -|GetActionPlaceResult|**record**|Структура, содержащая в себе возвращаемые данные в записях RefItem
182 -|(% colspan="3" %)**Структура RefItem**
183 -|Uid|guid| GUID места ремонта
184 -|Id|int|(не используется - возвращает всегда 0)
185 -|Name|string|Наименование места ремонта: В АСЦ, У клиента, В магазине
186 -|Description|string|(не используется)
187 -
188 188  * (((
189 189  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
190 190  )))
... ... @@ -191,47 +191,12 @@
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 -
212 212  * (((
213 213  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
214 214  )))
215 215  
216 -Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
120 +Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
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 -
235 235  * (((
236 236  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
237 237  )))
... ... @@ -309,7 +309,7 @@
309 309  
310 310  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
311 311  
312 -=== **Входные параметры:** ===
199 +**Входные параметры:**
313 313  
314 314  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
315 315  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -319,9 +319,9 @@
319 319  
320 320  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
321 321  
322 -=== **Выходные параметры:** ===
209 +**Выходные параметры:**
323 323  
324 -=== **Секция Tracking** ===
211 +**Секция Tracking**
325 325  
326 326  |Название параметра|Тип параметра|Описание параметра|Пример
327 327  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -413,10 +413,8 @@
413 413  |IMEI4NEW|**string (255)**|IMEI4 новый|
414 414  |RepairLevel|**string (300)**|Уровень ремонта|
415 415  
416 -=== Подсекция Parts секции Tracking ===
303 +Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
417 417  
418 -состоит из коллекции типа PartRecord следующего формата:
419 -
420 420  |Название параметра|Тип параметра|Описание параметра|Пример
421 421  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
422 422  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -453,7 +453,7 @@
453 453  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
454 454  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
455 455  
456 -=== Секция Payment ===
341 +**Секция Payment**
457 457  
458 458  |Название параметра|Тип параметра|Описание параметра|Пример
459 459  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -478,15 +478,13 @@
478 478  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
479 479  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
480 480  
481 -=== Ссылка на ремонт ===
366 +**Отдельный параметр**
482 482  
483 483  |Название параметра|Тип параметра|Описание параметра|Пример
484 484  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
485 485  
486 -=== Секция ValidationErrors ===
371 +Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
487 487  
488 -содержит коллекцию ErrorItem следующего вида:
489 -
490 490  |Название параметра|Тип параметра|Описание параметра|Пример
491 491  |ErrorCode|**string**|Код ошибки|43
492 492  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -499,7 +499,7 @@
499 499  
500 500  Возвращает трекинг по системному номеру (OrderNum).
501 501  
502 -=== **Входные параметры:** ===
385 +**Входные параметры:**
503 503  
504 504  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
505 505  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -509,9 +509,9 @@
509 509  
510 510  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
511 511  
512 -=== **Выходные параметры:** ===
395 +**Выходные параметры:**
513 513  
514 -=== **Секция Tracking** ===
397 +**Секция Tracking**
515 515  
516 516  |Название параметра|Тип параметра|Описание параметра|Пример
517 517  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -603,10 +603,8 @@
603 603  |IMEI4NEW|**string (255)**|IMEI4 новый|
604 604  |RepairLevel|**string (300)**|Уровень ремонта|
605 605  
606 -=== Подсекция Parts секции Tracking ===
489 +Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
607 607  
608 -состоит из коллекции типа PartRecord следующего формата:
609 -
610 610  |Название параметра|Тип параметра|Описание параметра|Пример
611 611  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
612 612  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -643,7 +643,7 @@
643 643  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
644 644  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
645 645  
646 -=== Секция Payment ===
527 +**Секция Payment**
647 647  
648 648  |Название параметра|Тип параметра|Описание параметра|Пример
649 649  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -668,15 +668,13 @@
668 668  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
669 669  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
670 670  
671 -=== Ссылка на ремонт ===
552 +**Отдельный параметр**
672 672  
673 673  |Название параметра|Тип параметра|Описание параметра|Пример
674 674  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
675 675  
676 -=== Секция ValidationErrors ===
557 +Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
677 677  
678 -содержит коллекцию ErrorItem следующего вида:
679 -
680 680  |Название параметра|Тип параметра|Описание параметра|Пример
681 681  |ErrorCode|**string**|Код ошибки|43
682 682  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -689,12 +689,12 @@
689 689  
690 690  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
691 691  
692 -=== Входные параметры: ===
571 +Входные параметры:
693 693  
694 694  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
695 695  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
696 696  
697 -=== Выходные параметры: ===
576 +Выходные параметры:
698 698  
699 699  Возвращает коллекцию TrackingShortItem следующего вида:
700 700  
... ... @@ -735,17 +735,18 @@
735 735  |Id|**int**|Id типа ремонта|
736 736  |Description|**string**|Описание типа ремонта|
737 737  
617 +* (((
738 738  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
619 +)))
739 739  
740 -
741 741  Возвращает список статусов трекинга.
742 742  
743 -=== Входные параметры: ===
623 +**Входные параметры:**
744 744  
745 745  |Название параметра|Тип параметра|Обяз.|Описание параметра|Пример
746 746  |ticket|**string**|Да|Сессионный ключ|srry8gJT2TJNZzckI6vGWwiRGZ6BcurM
747 747  
748 -=== Возвращаемое значение: ===
628 +**Выходные параметры:**
749 749  
750 750  Возвращает коллекцию StatusItem следующего вида:
751 751  
... ... @@ -755,17 +755,19 @@
755 755  |Description|**string (100)**|Описание статуса|ОТЧЕТ
756 756  |IsEnd|**boolean**|Является ли статус конечным|false
757 757  
638 +* (((
758 758  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
640 +)))
759 759  
760 760  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
761 761  
762 -=== Входные параметры: ===
644 +Входные параметры:
763 763  
764 764  |(% style="width:206px" %)Название параметра|(% style="width:130px" %)Тип параметра|(% style="width:70px" %)Обяз.|(% style="width:234px" %)Описание параметра|(% style="width:343px" %)Пример
765 765  |(% style="width:206px" %)Login|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Логин пользователя|(% style="width:343px" %)Vasya
766 766  |(% style="width:206px" %)Password|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Пароль пользователя|(% style="width:343px" %)123456
767 767  
768 -=== Возвращаемое значение: ===
650 +Возвращаемое значение:
769 769  
770 770  |Тип параметра|Описание параметра|Пример
771 771  |string|Сессионный ключ|YOB7IG8UG687068
... ... @@ -788,11 +788,13 @@
788 788  
789 789  Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
790 790  
673 +* (((
791 791  == [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] ==
675 +)))
792 792  
793 793  Создание/обновление трекинга.
794 794  
795 -=== Входные параметры: ===
679 +Входные параметры:
796 796  
797 797  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
798 798  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -800,7 +800,7 @@
800 800  структура содержащая данные, идентична секции Tracking в методе [[GetOrderBySysKey>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]]
801 801  )))|
802 802  
803 -=== Выходные параметры: ===
687 +Выходные параметры:
804 804  
805 805  |Название параметра|Тип параметра|Описание параметра|Пример
806 806  |TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода SaveOrder, если нужно обновить значения трекинга.|
... ... @@ -822,8 +822,6 @@
822 822  )))|Added
823 823  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
824 824  
825 -=== Ошибки при сохранении ремонта ===
826 -
827 827  Секция Errors содержит коллекцию строк ошибок.
828 828  
829 829  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: