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

Редактировал(а) Дмитрий Семёнов 2025/04/10 15:52
От версии < 23.10 >
отредактировано Дмитрий Семёнов
на 2025/03/28 16:01
К версии < 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,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,25 +191,6 @@
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 -
213 213  * (((
214 214  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
215 215  )))
... ... @@ -711,17 +711,18 @@
711 711  |Id|**int**|Id типа ремонта|
712 712  |Description|**string**|Описание типа ремонта|
713 713  
617 +* (((
714 714  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
619 +)))
715 715  
716 -
717 717  Возвращает список статусов трекинга.
718 718  
719 -=== Входные параметры: ===
623 +**Входные параметры:**
720 720  
721 721  |Название параметра|Тип параметра|Обяз.|Описание параметра|Пример
722 722  |ticket|**string**|Да|Сессионный ключ|srry8gJT2TJNZzckI6vGWwiRGZ6BcurM
723 723  
724 -=== Возвращаемое значение: ===
628 +**Выходные параметры:**
725 725  
726 726  Возвращает коллекцию StatusItem следующего вида:
727 727  
... ... @@ -731,17 +731,19 @@
731 731  |Description|**string (100)**|Описание статуса|ОТЧЕТ
732 732  |IsEnd|**boolean**|Является ли статус конечным|false
733 733  
638 +* (((
734 734  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
640 +)))
735 735  
736 736  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
737 737  
738 -=== Входные параметры: ===
644 +Входные параметры:
739 739  
740 740  |(% style="width:206px" %)Название параметра|(% style="width:130px" %)Тип параметра|(% style="width:70px" %)Обяз.|(% style="width:234px" %)Описание параметра|(% style="width:343px" %)Пример
741 741  |(% style="width:206px" %)Login|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Логин пользователя|(% style="width:343px" %)Vasya
742 742  |(% style="width:206px" %)Password|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Пароль пользователя|(% style="width:343px" %)123456
743 743  
744 -=== Возвращаемое значение: ===
650 +Возвращаемое значение:
745 745  
746 746  |Тип параметра|Описание параметра|Пример
747 747  |string|Сессионный ключ|YOB7IG8UG687068
... ... @@ -764,11 +764,13 @@
764 764  
765 765  Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
766 766  
673 +* (((
767 767  == [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] ==
675 +)))
768 768  
769 769  Создание/обновление трекинга.
770 770  
771 -=== Входные параметры: ===
679 +Входные параметры:
772 772  
773 773  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
774 774  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -776,7 +776,7 @@
776 776  структура содержащая данные, идентична секции Tracking в методе [[GetOrderBySysKey>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]]
777 777  )))|
778 778  
779 -=== Выходные параметры: ===
687 +Выходные параметры:
780 780  
781 781  |Название параметра|Тип параметра|Описание параметра|Пример
782 782  |TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода SaveOrder, если нужно обновить значения трекинга.|