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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -96,7 +96,7 @@
96 96  
97 97  Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
98 98  
99 -== Входные параметры ==
99 +=== Входные параметры ===
100 100  
101 101  |Название параметра|Тип параметра|Обяз.|Описание параметра
102 102  |ticket|string|Да|Сессионный ключ
... ... @@ -104,7 +104,7 @@
104 104  |trackingId|string|Нет|Номер ремонта (ETxxxxxxx)
105 105  |trackingUid|guid|Нет|GUID ремонта (b63f5255-198d-46d6-aaa5-9f9255f3de9b)
106 106  
107 -== Возвращаемое значение ==
107 +=== Возвращаемое значение ===
108 108  
109 109  |**Название параметра**|**Тип параметра**|**Описание параметра**
110 110  |GetANRPInfoResult|**record**|Структура, содержащая в себе возвращаемые данные
... ... @@ -132,7 +132,7 @@
132 132  
133 133  Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
134 134  
135 -== Входные параметры ==
135 +=== Входные параметры ===
136 136  
137 137  |Название параметра|Тип параметра|Обяз.|Описание параметра
138 138  |ticket|string|Да|Сессионный ключ
... ... @@ -140,7 +140,7 @@
140 140  |trackingId|string|Нет|Номер ремонта (ETxxxxxxx)
141 141  |trackingUid|guid|Нет|GUID ремонта (b63f5255-198d-46d6-aaa5-9f9255f3de9b)
142 142  
143 -== Возвращаемое значение ==
143 +=== Возвращаемое значение ===
144 144  
145 145  |**Название параметра**|**Тип параметра**|**Описание параметра**
146 146  |GetATOInfoResult|**record**|Структура, содержащая в себе возвращаемые данные
... ... @@ -168,6 +168,23 @@
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 +
171 171  * (((
172 172  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
173 173  )))
... ... @@ -174,12 +174,47 @@
174 174  
175 175  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
176 176  
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 +
177 177  * (((
178 178  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
179 179  )))
180 180  
181 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
182 182  
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 +
183 183  * (((
184 184  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
185 185  )))
... ... @@ -186,6 +186,22 @@
186 186  
187 187  Возвращает список типов вложений
188 188  
241 +=== Входные параметры ===
242 +
243 +|Название параметра|Тип параметра|Обяз.|Описание параметра
244 +|message.ticket|string|Да|Сессионный ключ
245 +|message.Version|string|Нет|Версия протокола (1.0)
246 +|MainBrandUid|GUID|Да|Идентификатор бренда
247 +
248 +=== Возвращаемое значение ===
249 +
250 +|**Название параметра**|**Тип параметра**|**Описание параметра**
251 +|GetAttachmentTypesResult|**record**|Структура, содержащая в себе возвращаемые данные в виде списка объектов RefItem
252 +|(% colspan="3" %)**Структура RefItem**
253 +|Uid|guid| GUID типа вложения
254 +|Name|string|Наименование типа вложения
255 +|ID|int|Индекс типа вложения (на данный момент не используется)
256 +
189 189  * (((
190 190  == [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]] ==
191 191  )))
... ... @@ -192,7 +192,7 @@
192 192  
193 193  Возвращает список брендов в разрезе групп брендов.
194 194  
195 -**Входные параметры:**
263 +=== Входные параметры: ===
196 196  
197 197  Секция message
198 198  
... ... @@ -199,7 +199,7 @@
199 199  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
200 200  |ticket|**string**|Да|Сессионный ключ|Vasya
201 201  
202 -**Выходные параметры:**
270 +=== Возвращаемое значение: ===
203 203  
204 204  Возвращает коллекцию BrandItem следующего вида:
205 205  
... ... @@ -257,7 +257,7 @@
257 257  
258 258  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
259 259  
260 -**Входные параметры:**
328 +=== **Входные параметры:** ===
261 261  
262 262  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
263 263  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -267,9 +267,9 @@
267 267  
268 268  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
269 269  
270 -**Выходные параметры:**
338 +=== **Выходные параметры:** ===
271 271  
272 -**Секция Tracking**
340 +=== **Секция Tracking** ===
273 273  
274 274  |Название параметра|Тип параметра|Описание параметра|Пример
275 275  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -361,8 +361,10 @@
361 361  |IMEI4NEW|**string (255)**|IMEI4 новый|
362 362  |RepairLevel|**string (300)**|Уровень ремонта|
363 363  
364 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
432 +=== Подсекция Parts секции Tracking ===
365 365  
434 +состоит из коллекции типа PartRecord следующего формата:
435 +
366 366  |Название параметра|Тип параметра|Описание параметра|Пример
367 367  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
368 368  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -399,7 +399,7 @@
399 399  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
400 400  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
401 401  
402 -**Секция Payment**
472 +=== Секция Payment ===
403 403  
404 404  |Название параметра|Тип параметра|Описание параметра|Пример
405 405  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -424,13 +424,15 @@
424 424  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
425 425  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
426 426  
427 -**Отдельный параметр**
497 +=== Ссылка на ремонт ===
428 428  
429 429  |Название параметра|Тип параметра|Описание параметра|Пример
430 430  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
431 431  
432 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
502 +=== Секция ValidationErrors ===
433 433  
504 +содержит коллекцию ErrorItem следующего вида:
505 +
434 434  |Название параметра|Тип параметра|Описание параметра|Пример
435 435  |ErrorCode|**string**|Код ошибки|43
436 436  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -443,7 +443,7 @@
443 443  
444 444  Возвращает трекинг по системному номеру (OrderNum).
445 445  
446 -**Входные параметры:**
518 +=== **Входные параметры:** ===
447 447  
448 448  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
449 449  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -453,9 +453,9 @@
453 453  
454 454  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
455 455  
456 -**Выходные параметры:**
528 +=== **Выходные параметры:** ===
457 457  
458 -**Секция Tracking**
530 +=== **Секция Tracking** ===
459 459  
460 460  |Название параметра|Тип параметра|Описание параметра|Пример
461 461  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -547,8 +547,10 @@
547 547  |IMEI4NEW|**string (255)**|IMEI4 новый|
548 548  |RepairLevel|**string (300)**|Уровень ремонта|
549 549  
550 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
622 +=== Подсекция Parts секции Tracking ===
551 551  
624 +состоит из коллекции типа PartRecord следующего формата:
625 +
552 552  |Название параметра|Тип параметра|Описание параметра|Пример
553 553  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
554 554  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -585,7 +585,7 @@
585 585  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
586 586  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
587 587  
588 -**Секция Payment**
662 +=== Секция Payment ===
589 589  
590 590  |Название параметра|Тип параметра|Описание параметра|Пример
591 591  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -610,13 +610,15 @@
610 610  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
611 611  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
612 612  
613 -**Отдельный параметр**
687 +=== Ссылка на ремонт ===
614 614  
615 615  |Название параметра|Тип параметра|Описание параметра|Пример
616 616  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
617 617  
618 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
692 +=== Секция ValidationErrors ===
619 619  
694 +содержит коллекцию ErrorItem следующего вида:
695 +
620 620  |Название параметра|Тип параметра|Описание параметра|Пример
621 621  |ErrorCode|**string**|Код ошибки|43
622 622  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -629,12 +629,12 @@
629 629  
630 630  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
631 631  
632 -Входные параметры:
708 +=== Входные параметры: ===
633 633  
634 634  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
635 635  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
636 636  
637 -Выходные параметры:
713 +=== Выходные параметры: ===
638 638  
639 639  Возвращает коллекцию TrackingShortItem следующего вида:
640 640  
... ... @@ -762,6 +762,8 @@
762 762  )))|Added
763 763  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
764 764  
841 +=== Ошибки при сохранении ремонта ===
842 +
765 765  Секция Errors содержит коллекцию строк ошибок.
766 766  
767 767  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: