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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -65,9 +65,11 @@
65 65  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
66 66  
67 67  === Сообщения об ошибках ===
68 +
68 68  Секция Errors содержит коллекцию строк ошибок.
69 69  
70 70  === Сообщения о валидационных проверках ===
72 +
71 71  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
72 72  
73 73  |Название параметра|Тип параметра|Описание параметра|Пример
... ... @@ -81,24 +81,85 @@
81 81  Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
82 82  
83 83  === Входные параметры ===
86 +
84 84  |Название параметра|Тип параметра|Описание параметра|Пример
85 -|numberKey|string|Идентификатор вложения|
86 -|typeUid|string|Идентификатор типа вложения (GUID)||
88 +|numberKey|string|Идентификатор вложения|
89 +|typeUid|string|Идентификатор типа вложения (GUID)| |
87 87  
88 88  === Выходные параметры ===
89 -Возвращает логическое значение об успешности выполнения операции
90 90  
93 +Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции
94 +
91 91  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
92 92  
97 +Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
93 93  
94 -Получение информации по акту неремонтопригодности.
99 +=== Входные параметры ===
95 95  
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 +
96 96  * (((
97 97  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
98 98  )))
99 99  
100 -Получение информации по акту технического освидетельствования.
133 +Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
101 101  
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 +
102 102  * (((
103 103  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
104 104  )))
... ... @@ -105,6 +105,23 @@
105 105  
106 106  Возвращает справочник мест ремонта.
107 107  
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 +
108 108  * (((
109 109  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
110 110  )))
... ... @@ -111,12 +111,47 @@
111 111  
112 112  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
113 113  
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 +
114 114  * (((
115 115  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
116 116  )))
117 117  
118 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
119 119  
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 +
120 120  * (((
121 121  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
122 122  )))
... ... @@ -123,6 +123,22 @@
123 123  
124 124  Возвращает список типов вложений
125 125  
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 +
126 126  * (((
127 127  == [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]] ==
128 128  )))
... ... @@ -194,7 +194,7 @@
194 194  
195 195  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
196 196  
197 -**Входные параметры:**
328 +=== **Входные параметры:** ===
198 198  
199 199  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
200 200  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -204,9 +204,9 @@
204 204  
205 205  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
206 206  
207 -**Выходные параметры:**
338 +=== **Выходные параметры:** ===
208 208  
209 -**Секция Tracking**
340 +=== **Секция Tracking** ===
210 210  
211 211  |Название параметра|Тип параметра|Описание параметра|Пример
212 212  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -298,8 +298,10 @@
298 298  |IMEI4NEW|**string (255)**|IMEI4 новый|
299 299  |RepairLevel|**string (300)**|Уровень ремонта|
300 300  
301 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
432 +=== Подсекция Parts секции Tracking ===
302 302  
434 +состоит из коллекции типа PartRecord следующего формата:
435 +
303 303  |Название параметра|Тип параметра|Описание параметра|Пример
304 304  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
305 305  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -336,7 +336,7 @@
336 336  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
337 337  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
338 338  
339 -**Секция Payment**
472 +=== Секция Payment ===
340 340  
341 341  |Название параметра|Тип параметра|Описание параметра|Пример
342 342  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -361,13 +361,15 @@
361 361  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
362 362  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
363 363  
364 -**Отдельный параметр**
497 +=== Ссылка на ремонт ===
365 365  
366 366  |Название параметра|Тип параметра|Описание параметра|Пример
367 367  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
368 368  
369 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
502 +=== Секция ValidationErrors ===
370 370  
504 +содержит коллекцию ErrorItem следующего вида:
505 +
371 371  |Название параметра|Тип параметра|Описание параметра|Пример
372 372  |ErrorCode|**string**|Код ошибки|43
373 373  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -380,7 +380,7 @@
380 380  
381 381  Возвращает трекинг по системному номеру (OrderNum).
382 382  
383 -**Входные параметры:**
518 +=== **Входные параметры:** ===
384 384  
385 385  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
386 386  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -390,9 +390,9 @@
390 390  
391 391  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
392 392  
393 -**Выходные параметры:**
528 +=== **Выходные параметры:** ===
394 394  
395 -**Секция Tracking**
530 +=== **Секция Tracking** ===
396 396  
397 397  |Название параметра|Тип параметра|Описание параметра|Пример
398 398  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -484,8 +484,10 @@
484 484  |IMEI4NEW|**string (255)**|IMEI4 новый|
485 485  |RepairLevel|**string (300)**|Уровень ремонта|
486 486  
487 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
622 +=== Подсекция Parts секции Tracking ===
488 488  
624 +состоит из коллекции типа PartRecord следующего формата:
625 +
489 489  |Название параметра|Тип параметра|Описание параметра|Пример
490 490  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
491 491  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -522,7 +522,7 @@
522 522  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
523 523  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
524 524  
525 -**Секция Payment**
662 +=== Секция Payment ===
526 526  
527 527  |Название параметра|Тип параметра|Описание параметра|Пример
528 528  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -547,13 +547,15 @@
547 547  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
548 548  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
549 549  
550 -**Отдельный параметр**
687 +=== Ссылка на ремонт ===
551 551  
552 552  |Название параметра|Тип параметра|Описание параметра|Пример
553 553  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
554 554  
555 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
692 +=== Секция ValidationErrors ===
556 556  
694 +содержит коллекцию ErrorItem следующего вида:
695 +
557 557  |Название параметра|Тип параметра|Описание параметра|Пример
558 558  |ErrorCode|**string**|Код ошибки|43
559 559  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -566,12 +566,12 @@
566 566  
567 567  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
568 568  
569 -Входные параметры:
708 +=== Входные параметры: ===
570 570  
571 571  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
572 572  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
573 573  
574 -Выходные параметры:
713 +=== Выходные параметры: ===
575 575  
576 576  Возвращает коллекцию TrackingShortItem следующего вида:
577 577  
... ... @@ -612,7 +612,6 @@
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 617  
618 618  
... ... @@ -633,7 +633,6 @@
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 638  
639 639  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
... ... @@ -701,6 +701,8 @@
701 701  )))|Added
702 702  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
703 703  
841 +=== Ошибки при сохранении ремонта ===
842 +
704 704  Секция Errors содержит коллекцию строк ошибок.
705 705  
706 706  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: