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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -94,15 +94,74 @@
94 94  
95 95  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
96 96  
97 +Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
97 97  
98 -Получение информации по акту неремонтопригодности.
99 +=== Входные параметры ===
99 99  
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 +
100 100  * (((
101 101  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
102 102  )))
103 103  
104 -Получение информации по акту технического освидетельствования.
133 +Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
105 105  
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 +
106 106  * (((
107 107  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
108 108  )))
... ... @@ -109,6 +109,23 @@
109 109  
110 110  Возвращает справочник мест ремонта.
111 111  
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 +
112 112  * (((
113 113  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
114 114  )))
... ... @@ -115,12 +115,47 @@
115 115  
116 116  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
117 117  
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 +
118 118  * (((
119 119  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
120 120  )))
121 121  
122 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
123 123  
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 +
124 124  * (((
125 125  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
126 126  )))
... ... @@ -198,7 +198,7 @@
198 198  
199 199  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
200 200  
201 -**Входные параметры:**
312 +=== **Входные параметры:** ===
202 202  
203 203  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
204 204  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -208,9 +208,9 @@
208 208  
209 209  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
210 210  
211 -**Выходные параметры:**
322 +=== **Выходные параметры:** ===
212 212  
213 -**Секция Tracking**
324 +=== **Секция Tracking** ===
214 214  
215 215  |Название параметра|Тип параметра|Описание параметра|Пример
216 216  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -302,8 +302,10 @@
302 302  |IMEI4NEW|**string (255)**|IMEI4 новый|
303 303  |RepairLevel|**string (300)**|Уровень ремонта|
304 304  
305 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
416 +=== Подсекция Parts секции Tracking ===
306 306  
418 +состоит из коллекции типа PartRecord следующего формата:
419 +
307 307  |Название параметра|Тип параметра|Описание параметра|Пример
308 308  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
309 309  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -340,7 +340,7 @@
340 340  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
341 341  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
342 342  
343 -**Секция Payment**
456 +=== Секция Payment ===
344 344  
345 345  |Название параметра|Тип параметра|Описание параметра|Пример
346 346  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -365,13 +365,15 @@
365 365  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
366 366  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
367 367  
368 -**Отдельный параметр**
481 +=== Ссылка на ремонт ===
369 369  
370 370  |Название параметра|Тип параметра|Описание параметра|Пример
371 371  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
372 372  
373 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
486 +=== Секция ValidationErrors ===
374 374  
488 +содержит коллекцию ErrorItem следующего вида:
489 +
375 375  |Название параметра|Тип параметра|Описание параметра|Пример
376 376  |ErrorCode|**string**|Код ошибки|43
377 377  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -384,7 +384,7 @@
384 384  
385 385  Возвращает трекинг по системному номеру (OrderNum).
386 386  
387 -**Входные параметры:**
502 +=== **Входные параметры:** ===
388 388  
389 389  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
390 390  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -394,9 +394,9 @@
394 394  
395 395  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
396 396  
397 -**Выходные параметры:**
512 +=== **Выходные параметры:** ===
398 398  
399 -**Секция Tracking**
514 +=== **Секция Tracking** ===
400 400  
401 401  |Название параметра|Тип параметра|Описание параметра|Пример
402 402  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -488,8 +488,10 @@
488 488  |IMEI4NEW|**string (255)**|IMEI4 новый|
489 489  |RepairLevel|**string (300)**|Уровень ремонта|
490 490  
491 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
606 +=== Подсекция Parts секции Tracking ===
492 492  
608 +состоит из коллекции типа PartRecord следующего формата:
609 +
493 493  |Название параметра|Тип параметра|Описание параметра|Пример
494 494  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
495 495  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -526,7 +526,7 @@
526 526  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
527 527  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
528 528  
529 -**Секция Payment**
646 +=== Секция Payment ===
530 530  
531 531  |Название параметра|Тип параметра|Описание параметра|Пример
532 532  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -551,13 +551,15 @@
551 551  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
552 552  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
553 553  
554 -**Отдельный параметр**
671 +=== Ссылка на ремонт ===
555 555  
556 556  |Название параметра|Тип параметра|Описание параметра|Пример
557 557  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
558 558  
559 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
676 +=== Секция ValidationErrors ===
560 560  
678 +содержит коллекцию ErrorItem следующего вида:
679 +
561 561  |Название параметра|Тип параметра|Описание параметра|Пример
562 562  |ErrorCode|**string**|Код ошибки|43
563 563  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -570,12 +570,12 @@
570 570  
571 571  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
572 572  
573 -Входные параметры:
692 +=== Входные параметры: ===
574 574  
575 575  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
576 576  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
577 577  
578 -Выходные параметры:
697 +=== Выходные параметры: ===
579 579  
580 580  Возвращает коллекцию TrackingShortItem следующего вида:
581 581  
... ... @@ -703,6 +703,8 @@
703 703  )))|Added
704 704  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
705 705  
825 +=== Ошибки при сохранении ремонта ===
826 +
706 706  Секция Errors содержит коллекцию строк ошибок.
707 707  
708 708  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: