Изменения документа Интеграция с трекингом (API)
Редактировал(а) Дмитрий Семёнов 2025/04/10 15:52
отредактировано Дмитрий Семёнов
на 2025/03/19 14:30
на 2025/03/19 14:30
отредактировано Дмитрий Семёнов
на 2025/03/28 15:52
на 2025/03/28 15:52
Изменить комментарий:
К данной версии нет комментариев
Комментарий
-
Свойства страницы (1 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -6,6 +6,8 @@ 6 6 7 7 Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения. 8 8 9 +Для использования API необходимо пройти аутентификацию с помощью метода `GetTicket` для получения сессионного ключа, который будет использоваться для всех последующих запросов. 10 + 9 9 = Список методов = 10 10 11 11 == [[CreateTrackingCallCentr>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=CreateTrackingCallCentr]] == ... ... @@ -24,7 +24,6 @@ 24 24 |DesRepair|**string (3000)**|Нет|Заявленная неисправность 25 25 |RepairTypeUid|**guid**|Нет|((( 26 26 Тип ремонта (связь с брендами (Default)). Значение берется из метода [[GetSpRepairTypes>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]]. Если не заполнено, то подставится «Клиентский гарантийный». 27 - 28 28 29 29 ))) 30 30 |BrandUid|**guid**|Да|Бренд (торговая марка). Значение берётся из [[GetBrands>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]].BrandUid ... ... @@ -55,20 +55,20 @@ 55 55 |Result|**Added** or **Changed** or **NotFound** or **Error** or **Unknown**|((( 56 56 Результат выполнения операции: 57 57 58 -Added – трекинг создан и помещён в базу 59 - 60 -Changed – трекинг изменён 61 - 62 -NotFound – трекинг не найден по uid 63 - 64 -Error – ошибка в работе метода 65 - 66 -Unknown – неизвестная ошибка 59 ++ Added – трекинг создан и помещён в базу 60 ++ Changed – трекинг изменён 61 ++ NotFound – трекинг не найден по uid 62 ++ Error – ошибка в работе метода 63 ++ Unknown – неизвестная ошибка 67 67 )))|Added 68 68 |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере| 69 69 67 +=== Сообщения об ошибках === 68 + 70 70 Секция Errors содержит коллекцию строк ошибок. 71 71 71 +=== Сообщения о валидационных проверках === 72 + 72 72 Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: 73 73 74 74 |Название параметра|Тип параметра|Описание параметра|Пример ... ... @@ -77,28 +77,90 @@ 77 77 |Status|**string**|Статус трекинга| 78 78 |Descriptilon|**string**|Описание ошибки 79 79 80 -* ((( 81 81 == [[DeleteAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] == 82 -))) 83 83 84 84 Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения 85 85 86 86 === Входные параметры === 87 87 87 +|Название параметра|Тип параметра|Описание параметра|Пример 88 +|numberKey|string|Идентификатор вложения| 89 +|typeUid|string|Идентификатор типа вложения (GUID)| | 90 + 88 88 === Выходные параметры === 89 89 90 -* ((( 93 +Возвращает логическое в поле //DeleteAttachmentResult //значение об успешности выполнения операции 94 + 91 91 == [[GetANRPInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] == 92 -))) 93 93 94 -Получение информации по акту неремонтопригодности. 97 +Получение информации по акту неремонтопригодности с поиском по номеру АНРП (NSExxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта. 95 95 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 + 96 96 * ((( 97 97 == [[GetATOInfo>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] == 98 98 ))) 99 99 100 -Получение информации по акту технического освидетельствования. 133 +Получение информации по акту технического освидетельствования (АТО) с поиском по номеру ATO (ATOxxxxxxx), номеру ремонта (ETxxxxxxx) или GUID ремонта. 101 101 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 + 102 102 * ((( 103 103 == [[GetActionPlace>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] == 104 104 ))) ... ... @@ -105,6 +105,23 @@ 105 105 106 106 Возвращает справочник мест ремонта. 107 107 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 + 108 108 * ((( 109 109 == [[GetAttachment>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] == 110 110 ))) ... ... @@ -612,18 +612,17 @@ 612 612 |Id|**int**|Id типа ремонта| 613 613 |Description|**string**|Описание типа ремонта| 614 614 615 -* ((( 616 616 == [[GetSpStatuses>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] == 617 -))) 618 618 697 + 619 619 Возвращает список статусов трекинга. 620 620 621 - **Входные параметры:**700 +=== Входные параметры: === 622 622 623 623 |Название параметра|Тип параметра|Обяз.|Описание параметра|Пример 624 624 |ticket|**string**|Да|Сессионный ключ|srry8gJT2TJNZzckI6vGWwiRGZ6BcurM 625 625 626 - **Выходные параметры:**705 +=== Возвращаемое значение: === 627 627 628 628 Возвращает коллекцию StatusItem следующего вида: 629 629 ... ... @@ -633,19 +633,17 @@ 633 633 |Description|**string (100)**|Описание статуса|ОТЧЕТ 634 634 |IsEnd|**boolean**|Является ли статус конечным|false 635 635 636 -* ((( 637 637 == [[GetTicket>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] == 638 -))) 639 639 640 640 Получение бинарного идентификатора для аутентификации пользователя по логину и паролю. 641 641 642 -Входные параметры: 719 +=== Входные параметры: === 643 643 644 644 |(% style="width:206px" %)Название параметра|(% style="width:130px" %)Тип параметра|(% style="width:70px" %)Обяз.|(% style="width:234px" %)Описание параметра|(% style="width:343px" %)Пример 645 645 |(% style="width:206px" %)Login|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Логин пользователя|(% style="width:343px" %)Vasya 646 646 |(% style="width:206px" %)Password|(% style="width:130px" %)**string**|(% style="width:70px" %)Да|(% style="width:234px" %)Пароль пользователя|(% style="width:343px" %)123456 647 647 648 -Возвращаемое значение: 725 +=== Возвращаемое значение: === 649 649 650 650 |Тип параметра|Описание параметра|Пример 651 651 |string|Сессионный ключ|YOB7IG8UG687068 ... ... @@ -668,13 +668,11 @@ 668 668 669 669 Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа 670 670 671 -* ((( 672 672 == [[SaveOrder>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] == 673 -))) 674 674 675 675 Создание/обновление трекинга. 676 676 677 -Входные параметры: 752 +=== Входные параметры: === 678 678 679 679 |Название параметра|Тип параметра|Обяз?|Описание параметра|Пример 680 680 |ticket|**string**|Да|Сессионный ключ|YOB7IG8UG687068 ... ... @@ -682,7 +682,7 @@ 682 682 структура содержащая данные, идентична секции Tracking в методе [[GetOrderBySysKey>>url:http://care.ellpa.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]] 683 683 )))| 684 684 685 -Выходные параметры: 760 +=== Выходные параметры: === 686 686 687 687 |Название параметра|Тип параметра|Описание параметра|Пример 688 688 |TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода SaveOrder, если нужно обновить значения трекинга.|