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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -26,7 +26,6 @@
26 26  |DesRepair|**string (3000)**|Нет|Заявленная неисправность
27 27  |RepairTypeUid|**guid**|Нет|(((
28 28  Тип ремонта  (связь с брендами (Default)). Значение берется из метода [[GetSpRepairTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]]. Если не заполнено, то подставится «Клиентский гарантийный».
29 -
30 30  
31 31  )))
32 32  |BrandUid|**guid**|Да|Бренд (торговая марка). Значение берётся из [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]].BrandUid
... ... @@ -57,20 +57,20 @@
57 57  |Result|**Added** or **Changed** or **NotFound** or **Error** or **Unknown**|(((
58 58  Результат выполнения операции:
59 59  
60 -Added – трекинг создан и помещён в базу
61 -
62 -Changed – трекинг изменён
63 -
64 -NotFound – трекинг не найден по uid
65 -
66 -Error – ошибка в работе метода
67 -
68 -Unknown – неизвестная ошибка
59 ++ Added – трекинг создан и помещён в базу
60 ++ Changed – трекинг изменён
61 ++ NotFound – трекинг не найден по uid
62 ++ Error – ошибка в работе метода
63 ++ Unknown – неизвестная ошибка
69 69  )))|Added
70 70  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
71 71  
67 +=== Сообщения об ошибках ===
68 +
72 72  Секция Errors содержит коллекцию строк ошибок.
73 73  
71 +=== Сообщения о валидационных проверках ===
72 +
74 74  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
75 75  
76 76  |Название параметра|Тип параметра|Описание параметра|Пример
... ... @@ -79,28 +79,90 @@
79 79  |Status|**string**|Статус трекинга|
80 80  |Descriptilon|**string**|Описание ошибки
81 81  
82 -* (((
83 83  == [[DeleteAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] ==
84 -)))
85 85  
86 86  Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
87 87  
88 88  === Входные параметры ===
89 89  
87 +|Название параметра|Тип параметра|Описание параметра|Пример
88 +|numberKey|string|Идентификатор вложения|
89 +|typeUid|string|Идентификатор типа вложения (GUID)| |
90 +
90 90  === Выходные параметры ===
91 91  
92 -* (((
93 +Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции
94 +
93 93  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
94 -)))
95 95  
96 -Получение информации по акту неремонтопригодности.
97 +Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
97 97  
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 +
98 98  * (((
99 99  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
100 100  )))
101 101  
102 -Получение информации по акту технического освидетельствования.
133 +Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
103 103  
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 +
104 104  * (((
105 105  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
106 106  )))
... ... @@ -107,6 +107,23 @@
107 107  
108 108  Возвращает справочник мест ремонта.
109 109  
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 +
110 110  * (((
111 111  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
112 112  )))
... ... @@ -113,12 +113,47 @@
113 113  
114 114  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
115 115  
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 +
116 116  * (((
117 117  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
118 118  )))
119 119  
120 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
121 121  
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 +
122 122  * (((
123 123  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
124 124  )))
... ... @@ -196,7 +196,7 @@
196 196  
197 197  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
198 198  
199 -**Входные параметры:**
312 +=== **Входные параметры:** ===
200 200  
201 201  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
202 202  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -206,9 +206,9 @@
206 206  
207 207  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
208 208  
209 -**Выходные параметры:**
322 +=== **Выходные параметры:** ===
210 210  
211 -**Секция Tracking**
324 +=== **Секция Tracking** ===
212 212  
213 213  |Название параметра|Тип параметра|Описание параметра|Пример
214 214  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -300,8 +300,10 @@
300 300  |IMEI4NEW|**string (255)**|IMEI4 новый|
301 301  |RepairLevel|**string (300)**|Уровень ремонта|
302 302  
303 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
416 +=== Подсекция Parts секции Tracking ===
304 304  
418 +состоит из коллекции типа PartRecord следующего формата:
419 +
305 305  |Название параметра|Тип параметра|Описание параметра|Пример
306 306  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
307 307  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -338,7 +338,7 @@
338 338  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
339 339  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
340 340  
341 -**Секция Payment**
456 +=== Секция Payment ===
342 342  
343 343  |Название параметра|Тип параметра|Описание параметра|Пример
344 344  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -363,13 +363,15 @@
363 363  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
364 364  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
365 365  
366 -**Отдельный параметр**
481 +=== Ссылка на ремонт ===
367 367  
368 368  |Название параметра|Тип параметра|Описание параметра|Пример
369 369  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
370 370  
371 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
486 +=== Секция ValidationErrors ===
372 372  
488 +содержит коллекцию ErrorItem следующего вида:
489 +
373 373  |Название параметра|Тип параметра|Описание параметра|Пример
374 374  |ErrorCode|**string**|Код ошибки|43
375 375  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -382,7 +382,7 @@
382 382  
383 383  Возвращает трекинг по системному номеру (OrderNum).
384 384  
385 -**Входные параметры:**
502 +=== **Входные параметры:** ===
386 386  
387 387  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
388 388  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -392,9 +392,9 @@
392 392  
393 393  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
394 394  
395 -**Выходные параметры:**
512 +=== **Выходные параметры:** ===
396 396  
397 -**Секция Tracking**
514 +=== **Секция Tracking** ===
398 398  
399 399  |Название параметра|Тип параметра|Описание параметра|Пример
400 400  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -486,8 +486,10 @@
486 486  |IMEI4NEW|**string (255)**|IMEI4 новый|
487 487  |RepairLevel|**string (300)**|Уровень ремонта|
488 488  
489 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
606 +=== Подсекция Parts секции Tracking ===
490 490  
608 +состоит из коллекции типа PartRecord следующего формата:
609 +
491 491  |Название параметра|Тип параметра|Описание параметра|Пример
492 492  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
493 493  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -524,7 +524,7 @@
524 524  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
525 525  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
526 526  
527 -**Секция Payment**
646 +=== Секция Payment ===
528 528  
529 529  |Название параметра|Тип параметра|Описание параметра|Пример
530 530  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -549,13 +549,15 @@
549 549  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
550 550  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
551 551  
552 -**Отдельный параметр**
671 +=== Ссылка на ремонт ===
553 553  
554 554  |Название параметра|Тип параметра|Описание параметра|Пример
555 555  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
556 556  
557 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
676 +=== Секция ValidationErrors ===
558 558  
678 +содержит коллекцию ErrorItem следующего вида:
679 +
559 559  |Название параметра|Тип параметра|Описание параметра|Пример
560 560  |ErrorCode|**string**|Код ошибки|43
561 561  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -568,12 +568,12 @@
568 568  
569 569  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
570 570  
571 -Входные параметры:
692 +=== Входные параметры: ===
572 572  
573 573  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
574 574  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
575 575  
576 -Выходные параметры:
697 +=== Выходные параметры: ===
577 577  
578 578  Возвращает коллекцию TrackingShortItem следующего вида:
579 579  
... ... @@ -614,18 +614,17 @@
614 614  |Id|**int**|Id типа ремонта|
615 615  |Description|**string**|Описание типа ремонта|
616 616  
617 -* (((
618 618  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
619 -)))
620 620  
740 +
621 621  Возвращает список статусов трекинга.
622 622  
623 -**Входные параметры:**
743 +=== Входные параметры: ===
624 624  
625 625  |Название параметра|Тип параметра|Обяз.|Описание параметра|Пример
626 626  |ticket|**string**|Да|Сессионный ключ|srry8gJT2TJNZzckI6vGWwiRGZ6BcurM
627 627  
628 -**Выходные параметры:**
748 +=== Возвращаемое значение: ===
629 629  
630 630  Возвращает коллекцию StatusItem следующего вида:
631 631  
... ... @@ -635,19 +635,17 @@
635 635  |Description|**string (100)**|Описание статуса|ОТЧЕТ
636 636  |IsEnd|**boolean**|Является ли статус конечным|false
637 637  
638 -* (((
639 639  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
640 -)))
641 641  
642 642  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
643 643  
644 -Входные параметры:
762 +=== Входные параметры: ===
645 645  
646 646  |(% style="width:206px" %)Название параметра|(% style="width:130px" %)Тип параметра|(% style="width:70px" %)Обяз.|(% style="width:234px" %)Описание параметра|(% style="width:343px" %)Пример
647 647  |(% style="width:206px" %)Login|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Логин пользователя|(% style="width:343px" %)Vasya
648 648  |(% style="width:206px" %)Password|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Пароль пользователя|(% style="width:343px" %)123456
649 649  
650 -Возвращаемое значение:
768 +=== Возвращаемое значение: ===
651 651  
652 652  |Тип параметра|Описание параметра|Пример
653 653  |string|Сессионный ключ|YOB7IG8UG687068
... ... @@ -670,13 +670,11 @@
670 670  
671 671  Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
672 672  
673 -* (((
674 674  == [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] ==
675 -)))
676 676  
677 677  Создание/обновление трекинга.
678 678  
679 -Входные параметры:
795 +=== Входные параметры: ===
680 680  
681 681  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
682 682  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -684,7 +684,7 @@
684 684  структура содержащая данные, идентична секции Tracking в методе [[GetOrderBySysKey>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]]
685 685  )))|
686 686  
687 -Выходные параметры:
803 +=== Выходные параметры: ===
688 688  
689 689  |Название параметра|Тип параметра|Описание параметра|Пример
690 690  |TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода SaveOrder, если нужно обновить значения трекинга.|
... ... @@ -706,6 +706,8 @@
706 706  )))|Added
707 707  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
708 708  
825 +=== Ошибки при сохранении ремонта ===
826 +
709 709  Секция Errors содержит коллекцию строк ошибок.
710 710  
711 711  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: