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

Редактировал(а) Дмитрий Семёнов 2025/04/10 15:52
От версии < 23.1 >
отредактировано Дмитрий Семёнов
на 2025/03/19 14:45
К версии < 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  |Название параметра|Тип параметра|Описание параметра|Пример
... ... @@ -76,28 +76,90 @@
76 76  |Status|**string**|Статус трекинга|
77 77  |Descriptilon|**string**|Описание ошибки
78 78  
79 -* (((
80 80  == [[DeleteAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] ==
81 -)))
82 82  
83 83  Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
84 84  
85 85  === Входные параметры ===
86 86  
87 +|Название параметра|Тип параметра|Описание параметра|Пример
88 +|numberKey|string|Идентификатор вложения|
89 +|typeUid|string|Идентификатор типа вложения (GUID)| |
90 +
87 87  === Выходные параметры ===
88 88  
89 -* (((
93 +Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции
94 +
90 90  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
91 -)))
92 92  
93 -Получение информации по акту неремонтопригодности.
97 +Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
94 94  
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 +
95 95  * (((
96 96  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
97 97  )))
98 98  
99 -Получение информации по акту технического освидетельствования.
133 +Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
100 100  
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 +
101 101  * (((
102 102  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
103 103  )))
... ... @@ -104,6 +104,23 @@
104 104  
105 105  Возвращает справочник мест ремонта.
106 106  
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 +
107 107  * (((
108 108  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
109 109  )))
... ... @@ -110,12 +110,47 @@
110 110  
111 111  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
112 112  
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 +
113 113  * (((
114 114  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
115 115  )))
116 116  
117 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
216 +Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
118 118  
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 +
119 119  * (((
120 120  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
121 121  )))
... ... @@ -193,7 +193,7 @@
193 193  
194 194  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
195 195  
196 -**Входные параметры:**
312 +=== **Входные параметры:** ===
197 197  
198 198  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
199 199  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -203,9 +203,9 @@
203 203  
204 204  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
205 205  
206 -**Выходные параметры:**
322 +=== **Выходные параметры:** ===
207 207  
208 -**Секция Tracking**
324 +=== **Секция Tracking** ===
209 209  
210 210  |Название параметра|Тип параметра|Описание параметра|Пример
211 211  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -297,8 +297,10 @@
297 297  |IMEI4NEW|**string (255)**|IMEI4 новый|
298 298  |RepairLevel|**string (300)**|Уровень ремонта|
299 299  
300 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
416 +=== Подсекция Parts секции Tracking ===
301 301  
418 +состоит из коллекции типа PartRecord следующего формата:
419 +
302 302  |Название параметра|Тип параметра|Описание параметра|Пример
303 303  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
304 304  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -335,7 +335,7 @@
335 335  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
336 336  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
337 337  
338 -**Секция Payment**
456 +=== Секция Payment ===
339 339  
340 340  |Название параметра|Тип параметра|Описание параметра|Пример
341 341  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -360,13 +360,15 @@
360 360  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
361 361  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
362 362  
363 -**Отдельный параметр**
481 +=== Ссылка на ремонт ===
364 364  
365 365  |Название параметра|Тип параметра|Описание параметра|Пример
366 366  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
367 367  
368 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
486 +=== Секция ValidationErrors ===
369 369  
488 +содержит коллекцию ErrorItem следующего вида:
489 +
370 370  |Название параметра|Тип параметра|Описание параметра|Пример
371 371  |ErrorCode|**string**|Код ошибки|43
372 372  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -379,7 +379,7 @@
379 379  
380 380  Возвращает трекинг по системному номеру (OrderNum).
381 381  
382 -**Входные параметры:**
502 +=== **Входные параметры:** ===
383 383  
384 384  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
385 385  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -389,9 +389,9 @@
389 389  
390 390  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
391 391  
392 -**Выходные параметры:**
512 +=== **Выходные параметры:** ===
393 393  
394 -**Секция Tracking**
514 +=== **Секция Tracking** ===
395 395  
396 396  |Название параметра|Тип параметра|Описание параметра|Пример
397 397  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -483,8 +483,10 @@
483 483  |IMEI4NEW|**string (255)**|IMEI4 новый|
484 484  |RepairLevel|**string (300)**|Уровень ремонта|
485 485  
486 -Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
606 +=== Подсекция Parts секции Tracking ===
487 487  
608 +состоит из коллекции типа PartRecord следующего формата:
609 +
488 488  |Название параметра|Тип параметра|Описание параметра|Пример
489 489  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
490 490  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -521,7 +521,7 @@
521 521  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
522 522  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
523 523  
524 -**Секция Payment**
646 +=== Секция Payment ===
525 525  
526 526  |Название параметра|Тип параметра|Описание параметра|Пример
527 527  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -546,13 +546,15 @@
546 546  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
547 547  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
548 548  
549 -**Отдельный параметр**
671 +=== Ссылка на ремонт ===
550 550  
551 551  |Название параметра|Тип параметра|Описание параметра|Пример
552 552  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
553 553  
554 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
676 +=== Секция ValidationErrors ===
555 555  
678 +содержит коллекцию ErrorItem следующего вида:
679 +
556 556  |Название параметра|Тип параметра|Описание параметра|Пример
557 557  |ErrorCode|**string**|Код ошибки|43
558 558  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -565,12 +565,12 @@
565 565  
566 566  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
567 567  
568 -Входные параметры:
692 +=== Входные параметры: ===
569 569  
570 570  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
571 571  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
572 572  
573 -Выходные параметры:
697 +=== Выходные параметры: ===
574 574  
575 575  Возвращает коллекцию TrackingShortItem следующего вида:
576 576  
... ... @@ -611,7 +611,6 @@
611 611  |Id|**int**|Id типа ремонта|
612 612  |Description|**string**|Описание типа ремонта|
613 613  
614 -
615 615  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
616 616  
617 617  
... ... @@ -632,7 +632,6 @@
632 632  |Description|**string (100)**|Описание статуса|ОТЧЕТ
633 633  |IsEnd|**boolean**|Является ли статус конечным|false
634 634  
635 -
636 636  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
637 637  
638 638  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.