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