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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -6,6 +6,8 @@
6 6  
7 7  Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения.
8 8  
9 +Для использования API необходимо пройти аутентификацию с помощью метода `GetTicket` для получения сессионного ключа, который будет использоваться для всех последующих запросов.
10 +
9 9  = Список методов =
10 10  
11 11  == [[CreateTrackingCallCentr>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=CreateTrackingCallCentr]] ==
... ... @@ -24,7 +24,6 @@
24 24  |DesRepair|**string (3000)**|Нет|Заявленная неисправность
25 25  |RepairTypeUid|**guid**|Нет|(((
26 26  Тип ремонта  (связь с брендами (Default)). Значение берется из метода [[GetSpRepairTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]]. Если не заполнено, то подставится «Клиентский гарантийный».
27 -
28 28  
29 29  )))
30 30  |BrandUid|**guid**|Да|Бренд (торговая марка). Значение берётся из [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]].BrandUid
... ... @@ -55,20 +55,20 @@
55 55  |Result|**Added** or **Changed** or **NotFound** or **Error** or **Unknown**|(((
56 56  Результат выполнения операции:
57 57  
58 -Added – трекинг создан и помещён в базу
59 -
60 -Changed – трекинг изменён
61 -
62 -NotFound – трекинг не найден по uid
63 -
64 -Error – ошибка в работе метода
65 -
66 -Unknown – неизвестная ошибка
59 ++ Added – трекинг создан и помещён в базу
60 ++ Changed – трекинг изменён
61 ++ NotFound – трекинг не найден по uid
62 ++ Error – ошибка в работе метода
63 ++ Unknown – неизвестная ошибка
67 67  )))|Added
68 68  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
69 69  
67 +=== Сообщения об ошибках ===
68 +
70 70  Секция Errors содержит коллекцию строк ошибок.
71 71  
71 +=== Сообщения о валидационных проверках ===
72 +
72 72  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
73 73  
74 74  |Название параметра|Тип параметра|Описание параметра|Пример
... ... @@ -77,22 +77,56 @@
77 77  |Status|**string**|Статус трекинга|
78 78  |Descriptilon|**string**|Описание ошибки
79 79  
80 -* (((
81 81  == [[DeleteAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] ==
82 -)))
83 83  
84 84  Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
85 85  
86 86  === Входные параметры ===
87 87  
87 +|Название параметра|Тип параметра|Описание параметра|Пример
88 +|numberKey|string|Идентификатор вложения|
89 +|typeUid|string|Идентификатор типа вложения (GUID)| |
90 +
88 88  === Выходные параметры ===
89 89  
90 -* (((
93 +Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции
94 +
91 91  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
92 -)))
93 93  
94 -Получение информации по акту неремонтопригодности.
95 95  
98 +Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
99 +
100 +== Входные параметры ==
101 +
102 +|Название параметра|Тип параметра|Обяз.|Описание параметра
103 +|ticket|string|Да|Сессионный ключ
104 +|actID|string|Нет|Номер АНРП (NSExxxxx)
105 +|trackingId|string|Нет|Номер ремонта (ETxxxxxxx)
106 +|trackingUid|guid|Нет|GUID ремонта (b63f5255-198d-46d6-aaa5-9f9255f3de9b)
107 +
108 +== Возвращаемое значение ==
109 +
110 +|**Название параметра**|**Тип параметра**|**Описание параметра**
111 +|GetANRPInfoResult|**record**|Структура, содержащая в себе возвращаемые данные
112 +|(% colspan="3" %)**Структура GetANRPInfoResult**
113 +|ASCCodeNoSystem| |(не используется)
114 +|uid|guid|GUID акта
115 +|ActId|string|Номер акта
116 +|CreateDate|dateTime|Дата создания
117 +|ApprovalDate|dateTime|Дата утверждения акта (если он утверждён)
118 +|Brand|string|Бренд
119 +|BrandUid|guid|GUID бренда
120 +|Model|string|Наименование модели
121 +|SerialNumber|string|Серийный номер аппарата (если предусмотрен)
122 +|TrackingId|string|Номер трекинга
123 +|TrackingId|guid|GUID трекинга
124 +|ASCCode|string|Код АСЦ
125 +|ASCName|string|Наименование АСЦ
126 +|ASCCity|string|Город АСЦ
127 +|isApproved|boolean|Утверждён ли акт?
128 +|ErrorText|string|Сообщение об ошибке в акте
129 +
130 +
96 96  * (((
97 97  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
98 98  )))
... ... @@ -612,18 +612,17 @@
612 612  |Id|**int**|Id типа ремонта|
613 613  |Description|**string**|Описание типа ремонта|
614 614  
615 -* (((
616 616  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
617 -)))
618 618  
652 +
619 619  Возвращает список статусов трекинга.
620 620  
621 -**Входные параметры:**
655 +=== Входные параметры: ===
622 622  
623 623  |Название параметра|Тип параметра|Обяз.|Описание параметра|Пример
624 624  |ticket|**string**|Да|Сессионный ключ|srry8gJT2TJNZzckI6vGWwiRGZ6BcurM
625 625  
626 -**Выходные параметры:**
660 +=== Возвращаемое значение: ===
627 627  
628 628  Возвращает коллекцию StatusItem следующего вида:
629 629  
... ... @@ -633,19 +633,17 @@
633 633  |Description|**string (100)**|Описание статуса|ОТЧЕТ
634 634  |IsEnd|**boolean**|Является ли статус конечным|false
635 635  
636 -* (((
637 637  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
638 -)))
639 639  
640 640  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
641 641  
642 -Входные параметры:
674 +=== Входные параметры: ===
643 643  
644 644  |(% style="width:206px" %)Название параметра|(% style="width:130px" %)Тип параметра|(% style="width:70px" %)Обяз.|(% style="width:234px" %)Описание параметра|(% style="width:343px" %)Пример
645 645  |(% style="width:206px" %)Login|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Логин пользователя|(% style="width:343px" %)Vasya
646 646  |(% style="width:206px" %)Password|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Пароль пользователя|(% style="width:343px" %)123456
647 647  
648 -Возвращаемое значение:
680 +=== Возвращаемое значение: ===
649 649  
650 650  |Тип параметра|Описание параметра|Пример
651 651  |string|Сессионный ключ|YOB7IG8UG687068
... ... @@ -668,13 +668,11 @@
668 668  
669 669  Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
670 670  
671 -* (((
672 672  == [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] ==
673 -)))
674 674  
675 675  Создание/обновление трекинга.
676 676  
677 -Входные параметры:
707 +=== Входные параметры: ===
678 678  
679 679  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
680 680  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -682,7 +682,7 @@
682 682  структура содержащая данные, идентична секции Tracking в методе [[GetOrderBySysKey>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]]
683 683  )))|
684 684  
685 -Выходные параметры:
715 +=== Выходные параметры: ===
686 686  
687 687  |Название параметра|Тип параметра|Описание параметра|Пример
688 688  |TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода SaveOrder, если нужно обновить значения трекинга.|