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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -94,10 +94,9 @@
94 94  
95 95  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
96 96  
97 -
98 98  Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
99 99  
100 -== Входные параметры ==
99 +=== Входные параметры ===
101 101  
102 102  |Название параметра|Тип параметра|Обяз.|Описание параметра
103 103  |ticket|string|Да|Сессионный ключ
... ... @@ -105,7 +105,7 @@
105 105  |trackingId|string|Нет|Номер ремонта (ETxxxxxxx)
106 106  |trackingUid|guid|Нет|GUID ремонта (b63f5255-198d-46d6-aaa5-9f9255f3de9b)
107 107  
108 -== Возвращаемое значение ==
107 +=== Возвращаемое значение ===
109 109  
110 110  |**Название параметра**|**Тип параметра**|**Описание параметра**
111 111  |GetANRPInfoResult|**record**|Структура, содержащая в себе возвращаемые данные
... ... @@ -127,13 +127,42 @@
127 127  |isApproved|boolean|Утверждён ли акт?
128 128  |ErrorText|string|Сообщение об ошибке в акте
129 129  
130 -
131 131  * (((
132 132  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
133 133  )))
134 134  
135 -Получение информации по акту технического освидетельствования.
133 +Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
136 136  
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 +
137 137  * (((
138 138  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
139 139  )))
... ... @@ -140,6 +140,23 @@
140 140  
141 141  Возвращает справочник мест ремонта.
142 142  
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 +
143 143  * (((
144 144  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
145 145  )))
... ... @@ -146,12 +146,47 @@
146 146  
147 147  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
148 148  
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 +
149 149  * (((
150 150  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
151 151  )))
152 152  
153 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
154 154  
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 +
155 155  * (((
156 156  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
157 157  )))
... ... @@ -229,7 +229,7 @@
229 229  
230 230  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
231 231  
232 -**Входные параметры:**
312 +=== **Входные параметры:** ===
233 233  
234 234  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
235 235  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -239,9 +239,9 @@
239 239  
240 240  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
241 241  
242 -**Выходные параметры:**
322 +=== **Выходные параметры:** ===
243 243  
244 -**Секция Tracking**
324 +=== **Секция Tracking** ===
245 245  
246 246  |Название параметра|Тип параметра|Описание параметра|Пример
247 247  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -333,8 +333,10 @@
333 333  |IMEI4NEW|**string (255)**|IMEI4 новый|
334 334  |RepairLevel|**string (300)**|Уровень ремонта|
335 335  
336 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
416 +=== Подсекция Parts секции Tracking ===
337 337  
418 +состоит из коллекции типа PartRecord следующего формата:
419 +
338 338  |Название параметра|Тип параметра|Описание параметра|Пример
339 339  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
340 340  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -371,7 +371,7 @@
371 371  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
372 372  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
373 373  
374 -**Секция Payment**
456 +=== Секция Payment ===
375 375  
376 376  |Название параметра|Тип параметра|Описание параметра|Пример
377 377  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -396,13 +396,15 @@
396 396  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
397 397  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
398 398  
399 -**Отдельный параметр**
481 +=== Ссылка на ремонт ===
400 400  
401 401  |Название параметра|Тип параметра|Описание параметра|Пример
402 402  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
403 403  
404 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
486 +=== Секция ValidationErrors ===
405 405  
488 +содержит коллекцию ErrorItem следующего вида:
489 +
406 406  |Название параметра|Тип параметра|Описание параметра|Пример
407 407  |ErrorCode|**string**|Код ошибки|43
408 408  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -415,7 +415,7 @@
415 415  
416 416  Возвращает трекинг по системному номеру (OrderNum).
417 417  
418 -**Входные параметры:**
502 +=== **Входные параметры:** ===
419 419  
420 420  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
421 421  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -425,9 +425,9 @@
425 425  
426 426  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
427 427  
428 -**Выходные параметры:**
512 +=== **Выходные параметры:** ===
429 429  
430 -**Секция Tracking**
514 +=== **Секция Tracking** ===
431 431  
432 432  |Название параметра|Тип параметра|Описание параметра|Пример
433 433  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -519,8 +519,10 @@
519 519  |IMEI4NEW|**string (255)**|IMEI4 новый|
520 520  |RepairLevel|**string (300)**|Уровень ремонта|
521 521  
522 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
606 +=== Подсекция Parts секции Tracking ===
523 523  
608 +состоит из коллекции типа PartRecord следующего формата:
609 +
524 524  |Название параметра|Тип параметра|Описание параметра|Пример
525 525  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
526 526  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -557,7 +557,7 @@
557 557  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
558 558  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
559 559  
560 -**Секция Payment**
646 +=== Секция Payment ===
561 561  
562 562  |Название параметра|Тип параметра|Описание параметра|Пример
563 563  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -582,13 +582,15 @@
582 582  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
583 583  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
584 584  
585 -**Отдельный параметр**
671 +=== Ссылка на ремонт ===
586 586  
587 587  |Название параметра|Тип параметра|Описание параметра|Пример
588 588  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
589 589  
590 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
676 +=== Секция ValidationErrors ===
591 591  
678 +содержит коллекцию ErrorItem следующего вида:
679 +
592 592  |Название параметра|Тип параметра|Описание параметра|Пример
593 593  |ErrorCode|**string**|Код ошибки|43
594 594  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -601,12 +601,12 @@
601 601  
602 602  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
603 603  
604 -Входные параметры:
692 +=== Входные параметры: ===
605 605  
606 606  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
607 607  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
608 608  
609 -Выходные параметры:
697 +=== Выходные параметры: ===
610 610  
611 611  Возвращает коллекцию TrackingShortItem следующего вида:
612 612