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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -65,11 +65,9 @@
65 65  |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
66 66  
67 67  === Сообщения об ошибках ===
68 -
69 69  Секция Errors содержит коллекцию строк ошибок.
70 70  
71 71  === Сообщения о валидационных проверках ===
72 -
73 73  Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
74 74  
75 75  |Название параметра|Тип параметра|Описание параметра|Пример
... ... @@ -83,85 +83,25 @@
83 83  Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
84 84  
85 85  === Входные параметры ===
86 -
87 87  |Название параметра|Тип параметра|Описание параметра|Пример
88 -|numberKey|string|Идентификатор вложения|
89 -|typeUid|string|Идентификатор типа вложения (GUID)| |
85 +|numberKey|string|Идентификатор вложения|
86 +|typeUid|string|Идентификатор типа вложения (GUID)||
90 90  
91 91  === Выходные параметры ===
89 +Возвращает логическое значение об успешности выполнения операции
92 92  
93 -Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции
94 -
91 +* (((
95 95  == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] ==
93 +)))
96 96  
97 -Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
95 +Получение информации по акту неремонтопригодности.
98 98  
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 -
129 129  * (((
130 130  == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] ==
131 131  )))
132 132  
133 -Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта.
101 +Получение информации по акту технического освидетельствования.
134 134  
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 -
165 165  * (((
166 166  == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] ==
167 167  )))
... ... @@ -168,23 +168,6 @@
168 168  
169 169  Возвращает справочник мест ремонта.
170 170  
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 -
188 188  * (((
189 189  == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] ==
190 190  )))
... ... @@ -191,47 +191,12 @@
191 191  
192 192  Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
193 193  
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 -
212 212  * (((
213 213  == [[GetAttachmentKeys>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] ==
214 214  )))
215 215  
216 -Возвращает список вложений по системному номеру трекинга (NumberKey) без самих вложений.
119 +Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
217 217  
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 -
235 235  * (((
236 236  == [[GetAttachmentTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] ==
237 237  )))
... ... @@ -309,7 +309,7 @@
309 309  
310 310  Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
311 311  
312 -=== **Входные параметры:** ===
198 +**Входные параметры:**
313 313  
314 314  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
315 315  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -319,7 +319,7 @@
319 319  
320 320  )))|**string**|Да|Собственный номер ремонта АСЦ.|1.0.0.0
321 321  
322 -=== **Выходные параметры:** ===
208 +**Выходные параметры:**
323 323  
324 324  **Секция Tracking**
325 325  
... ... @@ -495,7 +495,7 @@
495 495  
496 496  Возвращает трекинг по системному номеру (OrderNum).
497 497  
498 -=== **Входные параметры:** ===
384 +**Входные параметры:**
499 499  
500 500  |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример
501 501  |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068
... ... @@ -505,9 +505,9 @@
505 505  
506 506  )))|**string**|Да|Системный номер ремонта. OrderNum секции трекинг.|1.0.0.0
507 507  
508 -=== **Выходные параметры:** ===
394 +**Выходные параметры:**
509 509  
510 -=== **Секция Tracking** ===
396 +**Секция Tracking**
511 511  
512 512  |Название параметра|Тип параметра|Описание параметра|Пример
513 513  |uid|**guid**|Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] в случае, если нужно обновить значения трекинга.|6e18064e-1cd3-4207-8ebe-08c4417db2be
... ... @@ -599,10 +599,8 @@
599 599  |IMEI4NEW|**string (255)**|IMEI4 новый|
600 600  |RepairLevel|**string (300)**|Уровень ремонта|
601 601  
602 -=== Подсекция Parts секции Tracking ===
488 +Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
603 603  
604 -состоит из коллекции типа PartRecord следующего формата:
605 -
606 606  |Название параметра|Тип параметра|Описание параметра|Пример
607 607  |uid|**guid**|Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга.|
608 608  |CreateDate|**datetime**|Дата создания (будет заменена на текущую)|
... ... @@ -639,7 +639,7 @@
639 639  |ProblemPartSerial|**string (255)**|Серийный номер неисправной детали|
640 640  |SetupPartSerial|**string (255)**|Серийный номер установленной детали|
641 641  
642 -=== Секция Payment ===
526 +**Секция Payment**
643 643  
644 644  |Название параметра|Тип параметра|Описание параметра|Пример
645 645  |uid|**guid**|Идентификатор заказа|00000000-0000-0000-0000-000000000000
... ... @@ -664,15 +664,13 @@
664 664  |SparePartsTotal|**decimal**|Всего стоимость з/ч|
665 665  |AdditionalLaborDescr|**String (1000)**|Описание дополнительных работ|
666 666  
667 -=== Ссылка на ремонт ===
551 +**Отдельный параметр**
668 668  
669 669  |Название параметра|Тип параметра|Описание параметра|Пример
670 670  |RefUri|**string**|Ссылка на трекинг, которую можно открыть в браузере|
671 671  
672 -=== Секция ValidationErrors ===
556 +Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
673 673  
674 -содержит коллекцию ErrorItem следующего вида:
675 -
676 676  |Название параметра|Тип параметра|Описание параметра|Пример
677 677  |ErrorCode|**string**|Код ошибки|43
678 678  |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.|1
... ... @@ -685,12 +685,12 @@
685 685  
686 686  Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
687 687  
688 -=== Входные параметры: ===
570 +Входные параметры:
689 689  
690 690  |(% style="width:180px" %)Название параметра|(% style="width:141px" %)Тип параметра|(% style="width:79px" %)Обяз.|(% style="width:415px" %)Описание параметра|(% style="width:168px" %)Пример
691 691  |(% style="width:180px" %)ticket|(% style="width:141px" %)**string**|(% style="width:79px" %)Да|(% style="width:415px" %)Сессионный ключ|(% style="width:168px" %)YOB7IG8UG687068
692 692  
693 -=== Выходные параметры: ===
575 +Выходные параметры:
694 694  
695 695  Возвращает коллекцию TrackingShortItem следующего вида:
696 696  
... ... @@ -731,6 +731,7 @@
731 731  |Id|**int**|Id типа ремонта|
732 732  |Description|**string**|Описание типа ремонта|
733 733  
616 +
734 734  == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] ==
735 735  
736 736  
... ... @@ -751,6 +751,7 @@
751 751  |Description|**string (100)**|Описание статуса|ОТЧЕТ
752 752  |IsEnd|**boolean**|Является ли статус конечным|false
753 753  
637 +
754 754  == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] ==
755 755  
756 756  Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.