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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -6,15 +6,15 @@
6 6  
7 7  Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения.
8 8  
9 -Для использования API необходимо пройти аутентификацию с помощью метода `GetTicket` для получения сессионного ключа, который будет использоваться для всех последующих запросов.
10 -
11 11  = Список методов =
12 12  
11 +(((
13 13  == [[CreateTrackingCallCentr>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=CreateTrackingCallCentr]] ==
13 +)))
14 14  
15 15  Предназначен для создания трекинга из системы колл-центра.
16 16  
17 -=== Входные параметры: ===
17 +==== Входные параметры: ====
18 18  
19 19  |Название параметра|Тип параметра|Обяз.|Описание параметра
20 20  |ticket|**string**|Да|Сессионный ключ
... ... @@ -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
... ... @@ -46,7 +46,7 @@
46 46  |PurchDate|**datetime**|Нет|Дата продажи
47 47  |UrlQuestionnaire|**string**|Нет|URL на анкету для прохождения опроса по завершению ремонта
48 48  
49 -=== Выходные параметры: ===
50 +==== Выходные параметры: ====
50 50  
51 51  |Название параметра|Тип параметра|Описание параметра|Пример
52 52  |TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]], если необходимо обновить значения трекинга.|
... ... @@ -56,18 +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 68  Секция Errors содержит коллекцию строк ошибок.
69 69  
70 -=== Сообщения о валидационных проверках ===
71 71  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
72 72  
73 73  |Название параметра|Тип параметра|Описание параметра|Пример
... ... @@ -76,21 +76,20 @@
76 76  |Status|**string**|Статус трекинга|
77 77  |Descriptilon|**string**|Описание ошибки
78 78  
82 +* (((
79 79  == [[DeleteAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] ==
84 +)))
80 80  
81 81  Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
82 82  
83 83  === Входные параметры ===
84 -|Название параметра|Тип параметра|Описание параметра|Пример
85 -|numberKey|string|Идентификатор вложения|
86 -|typeUid|string|Идентификатор типа вложения (GUID)||
87 87  
88 88  === Выходные параметры ===
89 -Возвращает логическое значение об успешности выполнения операции
90 90  
92 +* (((
91 91  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
94 +)))
92 92  
93 -
94 94  Получение информации по акту неремонтопригодности.
95 95  
96 96  * (((
... ... @@ -612,18 +612,18 @@
612 612  |Id|**int**|Id типа ремонта|
613 613  |Description|**string**|Описание типа ремонта|
614 614  
615 -
617 +* (((
616 616  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
619 +)))
617 617  
618 -
619 619  Возвращает список статусов трекинга.
620 620  
621 -=== Входные параметры: ===
623 +**Входные параметры:**
622 622  
623 623  |Название параметра|Тип параметра|Обяз.|Описание параметра|Пример
624 624  |ticket|**string**|Да|Сессионный ключ|srry8gJT2TJNZzckI6vGWwiRGZ6BcurM
625 625  
626 -=== Возвращаемое значение: ===
628 +**Выходные параметры:**
627 627  
628 628  Возвращает коллекцию StatusItem следующего вида:
629 629  
... ... @@ -633,18 +633,19 @@
633 633  |Description|**string (100)**|Описание статуса|ОТЧЕТ
634 634  |IsEnd|**boolean**|Является ли статус конечным|false
635 635  
636 -
638 +* (((
637 637  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
640 +)))
638 638  
639 639  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
640 640  
641 -=== Входные параметры: ===
644 +Входные параметры:
642 642  
643 643  |(% style="width:206px" %)Название параметра|(% style="width:130px" %)Тип параметра|(% style="width:70px" %)Обяз.|(% style="width:234px" %)Описание параметра|(% style="width:343px" %)Пример
644 644  |(% style="width:206px" %)Login|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Логин пользователя|(% style="width:343px" %)Vasya
645 645  |(% style="width:206px" %)Password|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Пароль пользователя|(% style="width:343px" %)123456
646 646  
647 -=== Возвращаемое значение: ===
650 +Возвращаемое значение:
648 648  
649 649  |Тип параметра|Описание параметра|Пример
650 650  |string|Сессионный ключ|YOB7IG8UG687068
... ... @@ -667,11 +667,13 @@
667 667  
668 668  Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
669 669  
673 +* (((
670 670  == [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] ==
675 +)))
671 671  
672 672  Создание/обновление трекинга.
673 673  
674 -=== Входные параметры: ===
679 +Входные параметры:
675 675  
676 676  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
677 677  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -679,7 +679,7 @@
679 679  структура содержащая данные, идентична секции Tracking в методе [[GetOrderBySysKey>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]]
680 680  )))|
681 681  
682 -=== Выходные параметры: ===
687 +Выходные параметры:
683 683  
684 684  |Название параметра|Тип параметра|Описание параметра|Пример
685 685  |TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода SaveOrder, если нужно обновить значения трекинга.|