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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -64,8 +64,12 @@
64 64  )))|Added
65 65  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
66 66  
67 +=== Сообщения об ошибках ===
68 +
67 67  Секция Errors содержит коллекцию строк ошибок.
68 68  
71 +=== Сообщения о валидационных проверках ===
72 +
69 69  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
70 70  
71 71  |Название параметра|Тип параметра|Описание параметра|Пример
... ... @@ -74,28 +74,90 @@
74 74  |Status|**string**|Статус трекинга|
75 75  |Descriptilon|**string**|Описание ошибки
76 76  
77 -* (((
78 78  == [[DeleteAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] ==
79 -)))
80 80  
81 81  Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
82 82  
83 83  === Входные параметры ===
84 84  
87 +|Название параметра|Тип параметра|Описание параметра|Пример
88 +|numberKey|string|Идентификатор вложения|
89 +|typeUid|string|Идентификатор типа вложения (GUID)| |
90 +
85 85  === Выходные параметры ===
86 86  
87 -* (((
93 +Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции
94 +
88 88  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
89 -)))
90 90  
91 -Получение информации по акту неремонтопригодности.
97 +Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
92 92  
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 +
93 93  * (((
94 94  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
95 95  )))
96 96  
97 -Получение информации по акту технического освидетельствования.
133 +Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
98 98  
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 +
99 99  * (((
100 100  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
101 101  )))
... ... @@ -102,6 +102,23 @@
102 102  
103 103  Возвращает справочник мест ремонта.
104 104  
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 +
105 105  * (((
106 106  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
107 107  )))
... ... @@ -108,12 +108,47 @@
108 108  
109 109  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
110 110  
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 +
111 111  * (((
112 112  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
113 113  )))
114 114  
115 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
116 116  
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 +
117 117  * (((
118 118  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
119 119  )))
... ... @@ -120,6 +120,22 @@
120 120  
121 121  Возвращает список типов вложений
122 122  
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 +
123 123  * (((
124 124  == [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]] ==
125 125  )))
... ... @@ -191,7 +191,7 @@
191 191  
192 192  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
193 193  
194 -**Входные параметры:**
328 +=== **Входные параметры:** ===
195 195  
196 196  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
197 197  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -201,9 +201,9 @@
201 201  
202 202  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
203 203  
204 -**Выходные параметры:**
338 +=== **Выходные параметры:** ===
205 205  
206 -**Секция Tracking**
340 +=== **Секция Tracking** ===
207 207  
208 208  |Название параметра|Тип параметра|Описание параметра|Пример
209 209  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -295,8 +295,10 @@
295 295  |IMEI4NEW|**string (255)**|IMEI4 новый|
296 296  |RepairLevel|**string (300)**|Уровень ремонта|
297 297  
298 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
432 +=== Подсекция Parts секции Tracking ===
299 299  
434 +состоит из коллекции типа PartRecord следующего формата:
435 +
300 300  |Название параметра|Тип параметра|Описание параметра|Пример
301 301  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
302 302  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -333,7 +333,7 @@
333 333  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
334 334  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
335 335  
336 -**Секция Payment**
472 +=== Секция Payment ===
337 337  
338 338  |Название параметра|Тип параметра|Описание параметра|Пример
339 339  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -358,13 +358,15 @@
358 358  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
359 359  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
360 360  
361 -**Отдельный параметр**
497 +=== Ссылка на ремонт ===
362 362  
363 363  |Название параметра|Тип параметра|Описание параметра|Пример
364 364  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
365 365  
366 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
502 +=== Секция ValidationErrors ===
367 367  
504 +содержит коллекцию ErrorItem следующего вида:
505 +
368 368  |Название параметра|Тип параметра|Описание параметра|Пример
369 369  |ErrorCode|**string**|Код ошибки|43
370 370  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -377,7 +377,7 @@
377 377  
378 378  Возвращает трекинг по системному номеру (OrderNum).
379 379  
380 -**Входные параметры:**
518 +=== **Входные параметры:** ===
381 381  
382 382  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
383 383  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -387,9 +387,9 @@
387 387  
388 388  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
389 389  
390 -**Выходные параметры:**
528 +=== **Выходные параметры:** ===
391 391  
392 -**Секция Tracking**
530 +=== **Секция Tracking** ===
393 393  
394 394  |Название параметра|Тип параметра|Описание параметра|Пример
395 395  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -481,8 +481,10 @@
481 481  |IMEI4NEW|**string (255)**|IMEI4 новый|
482 482  |RepairLevel|**string (300)**|Уровень ремонта|
483 483  
484 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
622 +=== Подсекция Parts секции Tracking ===
485 485  
624 +состоит из коллекции типа PartRecord следующего формата:
625 +
486 486  |Название параметра|Тип параметра|Описание параметра|Пример
487 487  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
488 488  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -519,7 +519,7 @@
519 519  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
520 520  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
521 521  
522 -**Секция Payment**
662 +=== Секция Payment ===
523 523  
524 524  |Название параметра|Тип параметра|Описание параметра|Пример
525 525  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -544,13 +544,15 @@
544 544  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
545 545  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
546 546  
547 -**Отдельный параметр**
687 +=== Ссылка на ремонт ===
548 548  
549 549  |Название параметра|Тип параметра|Описание параметра|Пример
550 550  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
551 551  
552 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
692 +=== Секция ValidationErrors ===
553 553  
694 +содержит коллекцию ErrorItem следующего вида:
695 +
554 554  |Название параметра|Тип параметра|Описание параметра|Пример
555 555  |ErrorCode|**string**|Код ошибки|43
556 556  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -563,12 +563,12 @@
563 563  
564 564  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
565 565  
566 -Входные параметры:
708 +=== Входные параметры: ===
567 567  
568 568  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
569 569  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
570 570  
571 -Выходные параметры:
713 +=== Выходные параметры: ===
572 572  
573 573  Возвращает коллекцию TrackingShortItem следующего вида:
574 574  
... ... @@ -609,7 +609,6 @@
609 609  |Id|**int**|Id типа ремонта|
610 610  |Description|**string**|Описание типа ремонта|
611 611  
612 -
613 613  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
614 614  
615 615  
... ... @@ -630,7 +630,6 @@
630 630  |Description|**string (100)**|Описание статуса|ОТЧЕТ
631 631  |IsEnd|**boolean**|Является ли статус конечным|false
632 632  
633 -
634 634  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
635 635  
636 636  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
... ... @@ -698,6 +698,8 @@
698 698  )))|Added
699 699  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
700 700  
841 +=== Ошибки при сохранении ремонта ===
842 +
701 701  Секция Errors содержит коллекцию строк ошибок.
702 702  
703 703  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: