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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -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,25 +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  
91 -* (((
93 +Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции
94 +
92 92  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
93 -)))
94 94  
95 -Получение информации по акту неремонтопригодности.
97 +Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
96 96  
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 +
97 97  * (((
98 98  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
99 99  )))
100 100  
101 -Получение информации по акту технического освидетельствования.
133 +Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
102 102  
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 +
103 103  * (((
104 104  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
105 105  )))
... ... @@ -106,6 +106,23 @@
106 106  
107 107  Возвращает справочник мест ремонта.
108 108  
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 +
109 109  * (((
110 110  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
111 111  )))
... ... @@ -112,12 +112,47 @@
112 112  
113 113  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
114 114  
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 +
115 115  * (((
116 116  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
117 117  )))
118 118  
119 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
120 120  
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 +
121 121  * (((
122 122  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
123 123  )))
... ... @@ -195,7 +195,7 @@
195 195  
196 196  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
197 197  
198 -**Входные параметры:**
312 +=== **Входные параметры:** ===
199 199  
200 200  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
201 201  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -205,9 +205,9 @@
205 205  
206 206  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
207 207  
208 -**Выходные параметры:**
322 +=== **Выходные параметры:** ===
209 209  
210 -**Секция Tracking**
324 +=== **Секция Tracking** ===
211 211  
212 212  |Название параметра|Тип параметра|Описание параметра|Пример
213 213  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -299,8 +299,10 @@
299 299  |IMEI4NEW|**string (255)**|IMEI4 новый|
300 300  |RepairLevel|**string (300)**|Уровень ремонта|
301 301  
302 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
416 +=== Подсекция Parts секции Tracking ===
303 303  
418 +состоит из коллекции типа PartRecord следующего формата:
419 +
304 304  |Название параметра|Тип параметра|Описание параметра|Пример
305 305  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
306 306  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -337,7 +337,7 @@
337 337  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
338 338  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
339 339  
340 -**Секция Payment**
456 +=== Секция Payment ===
341 341  
342 342  |Название параметра|Тип параметра|Описание параметра|Пример
343 343  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -362,13 +362,15 @@
362 362  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
363 363  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
364 364  
365 -**Отдельный параметр**
481 +=== Ссылка на ремонт ===
366 366  
367 367  |Название параметра|Тип параметра|Описание параметра|Пример
368 368  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
369 369  
370 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
486 +=== Секция ValidationErrors ===
371 371  
488 +содержит коллекцию ErrorItem следующего вида:
489 +
372 372  |Название параметра|Тип параметра|Описание параметра|Пример
373 373  |ErrorCode|**string**|Код ошибки|43
374 374  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -381,7 +381,7 @@
381 381  
382 382  Возвращает трекинг по системному номеру (OrderNum).
383 383  
384 -**Входные параметры:**
502 +=== **Входные параметры:** ===
385 385  
386 386  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
387 387  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -391,9 +391,9 @@
391 391  
392 392  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
393 393  
394 -**Выходные параметры:**
512 +=== **Выходные параметры:** ===
395 395  
396 -**Секция Tracking**
514 +=== **Секция Tracking** ===
397 397  
398 398  |Название параметра|Тип параметра|Описание параметра|Пример
399 399  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -485,8 +485,10 @@
485 485  |IMEI4NEW|**string (255)**|IMEI4 новый|
486 486  |RepairLevel|**string (300)**|Уровень ремонта|
487 487  
488 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
606 +=== Подсекция Parts секции Tracking ===
489 489  
608 +состоит из коллекции типа PartRecord следующего формата:
609 +
490 490  |Название параметра|Тип параметра|Описание параметра|Пример
491 491  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
492 492  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -523,7 +523,7 @@
523 523  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
524 524  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
525 525  
526 -**Секция Payment**
646 +=== Секция Payment ===
527 527  
528 528  |Название параметра|Тип параметра|Описание параметра|Пример
529 529  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -548,13 +548,15 @@
548 548  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
549 549  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
550 550  
551 -**Отдельный параметр**
671 +=== Ссылка на ремонт ===
552 552  
553 553  |Название параметра|Тип параметра|Описание параметра|Пример
554 554  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
555 555  
556 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
676 +=== Секция ValidationErrors ===
557 557  
678 +содержит коллекцию ErrorItem следующего вида:
679 +
558 558  |Название параметра|Тип параметра|Описание параметра|Пример
559 559  |ErrorCode|**string**|Код ошибки|43
560 560  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -567,12 +567,12 @@
567 567  
568 568  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
569 569  
570 -Входные параметры:
692 +=== Входные параметры: ===
571 571  
572 572  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
573 573  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
574 574  
575 -Выходные параметры:
697 +=== Выходные параметры: ===
576 576  
577 577  Возвращает коллекцию TrackingShortItem следующего вида:
578 578  
... ... @@ -613,7 +613,6 @@
613 613  |Id|**int**|Id типа ремонта|
614 614  |Description|**string**|Описание типа ремонта|
615 615  
616 -
617 617  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
618 618  
619 619  
... ... @@ -634,7 +634,6 @@
634 634  |Description|**string (100)**|Описание статуса|ОТЧЕТ
635 635  |IsEnd|**boolean**|Является ли статус конечным|false
636 636  
637 -
638 638  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
639 639  
640 640  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.