Изменения документа Интеграция с трекингом (API)
Редактировал(а) Дмитрий Семёнов 2025/04/10 15:52
отредактировано Григорий Лепёшкин
на 2023/12/21 15:04
на 2023/12/21 15:04
отредактировано Григорий Лепёшкин
на 2023/12/21 11:49
на 2023/12/21 11:49
Изменить комментарий:
К данной версии нет комментариев
Комментарий
-
Свойства страницы (1 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -8,235 +8,39 @@ 8 8 9 9 = Список методов = 10 10 11 -* ((( 12 -== [[CreateTrackingCallCentr>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=CreateTrackingCallCentr]] == 13 -))) 11 +* [[CreateTrackingCallCentr>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=CreateTrackingCallCentr]] - Создание трекинга колл-центра. 12 +* [[DeleteAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] -Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения 13 +* [[GetANRPInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] - Получение информации по акту неремонтопригодности. 14 +* [[GetATOInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] - Получение информации по акту технического освидетельствования. 15 +* [[GetActionPlace>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] - Возвращает справочник мест ремонта. 16 +* [[GetAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] - Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения. 17 +* [[GetAttachmentKeys>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] - Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений. 18 +* [[GetAttachmentTypes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] - Возвращает список типов вложений 19 +* [[GetBrands>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]] - Возвращает список брендов в разрезе групп брендов. 20 +* [[GetCategIrisConditionCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisConditionCodes]] - Возвращает справочник Iris Код условий по бренду и категории модели. 21 +* [[GetCategIrisDefectCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisDefectCodes]] - Возвращает справочник Iris Код дефектов по бренду и категории модели. 22 +* [[GetCategIrisRepairCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisRepairCodes]] - Возвращает справочник Iris Код ремонтов по бренду и категории модели. 23 +* [[GetCategIrisSectionCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisSectionCodes]] - Возвращает справочник Iris Код секций по бренду и категории модели. 24 +* [[GetCategIrisSymptomCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisSymptomCodes]] - Возвращает справочник Iris Код симптомов по бренду и категории модели. 25 +* [[GetIrisCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetIrisCodes]] - Возвращает Iris коды в разрезе типов Iris кодов (ConditionCode, DefectCode, RepairCode, sectionCode, SymptomCode), категорий моделей и брендов (в рамках активных авторизаций по брендам) 26 +* [[GetModelCategories>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetModelCategories]] - Возвращает справочник категорий моделей. 27 +* [[GetOrderByAscKey>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderByAscKey]] - Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc) 28 +* [[GetOrderBySysKey>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]] - Возвращает трекинг по системному номеру (OrderNum). 29 +* [[GetOrderKeys>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderKeys]] - Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус. 30 +* [[GetRejectReasons>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetRejectReasons]] - Список причин отмены трекинга 31 +* [[GetSpRepairTypes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]] - Возвращает справочник типов ремонтов по группе брендов (MainBrandUid). 32 +* [[GetSpStatuses>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] - Возвращает список статусов трекинга. 33 +* [[GetTicket>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] - Получение бинарного идентификатора для аутентификации пользователя по логину и паролю. 34 +* [[GetTransportService>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTransportService]] - Возвращает справочник типов транспортировки по мету ремонта и бренду. 35 +* [[GetTransportZone>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTransportZone]] - Возврат справочника зон транспортировки. 36 +* [[SaveAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveAttachment]] - Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа 37 +* [[SaveOrder>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] - Создание/обновление трекинга. 14 14 15 -Создание трекинга колл-центра. 16 - 17 -Входные параметры: 18 - 19 -|Название параметра|Тип параметра|Обяз.|Описание параметра 20 -|ticket|**string**|Да|Сессионный ключ 21 -|record|**record**|Да|структура содержащая данные 22 -|(% colspan="4" %)**Структура Record** 23 -|Model|**string (50)**|Да|Строка названия модели 24 -|OrderNumBrand|**string (50)**|Да|Номер заявки колл-центра 25 -|SerialNumb|**string (50)**|Нет|Серийный номер 26 -|DesRepair|**string (3000)**|Нет|Заявленная неисправность 27 -|RepairTypeUid|**guid**|Нет|((( 28 -Тип ремонта (связь с брендами (Default)). Значение берется из метода [[GetSpRepairTypes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]]. Если не заполнено, то подставится «Клиентский гарантийный». 29 - 30 - 31 -))) 32 -|BrandUid|**guid**|Да|Бренд (торговая марка). Значение берётся из [[GetBrands>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]].BrandUid 33 -|CountryServiceCenter|**string (2)**|Нет|Стана АСЦ. Указывается страна в виде кода ALFA-2. Если страна найдена, то город будет сопоставляться с городами этой страны, иначе со страной пользователя колл-центра. 34 -|CityServiceCenter|**string (255)**|Нет|Город АСЦ. Город подбирается по тексту и стране. Если город найден, то по городу и бренду осуществляется поиск АСЦ. Если найден единственный АСЦ, то подставляется он иначе, если не единственный или если город не найден, то берется город пользователя колл-центра и в качестве АСЦ указывается пусто. Далее при редактировании данного трекинга на сайте, его не возможно сохранить с пустым АСЦ. 35 -|CName|**string (255)**|Нет|Имя клиента 36 -|CSurname|**string (255)**|Нет|Фамилия клиента 37 -|CPatronymic|**string (255)**|Нет|Отчество клиента 38 -|CCity|**string (255)**|Нет|Город клиента 39 -|CAddress|**string (255)**|Нет|Адрес клиента 40 -|CHouse|**string (5)**|Нет|Номер дома клиента 41 -|CBuild|**string (5)**|Нет|Корпус дома клиента 42 -|CFlat|**string (5)**|Нет|Номер квартиры клиента 43 -|CMobTel|**string (15)**|Нет|Мобильный телефон клиента 44 -|Cemail|**string (255)**|Нет|Email клиента 45 -|UrlQuestionnaire|**string**|Нет|URL на анкету для прохождения опроса по завершению ремонта 46 - 47 -Выходные параметры: 48 - 49 -|Название параметра|Тип параметра|Описание параметра|Пример 50 -|TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода [[SaveOrder>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]], если необходимо обновить значения трекинга.| 51 -|SysNum|**string**|Системный номер трекинга (учётный номер ремонта в системе)| 52 -|StatusName|**string**|Статус трекинга| 53 -|StatusUid|**guid**|UID статуса трекинга. Значение берётся из [[GetSpStatuses>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]].| 54 -|Result|**Added** or **Changed** or **NotFound** or **Error** or **Unknown**|((( 55 -Результат выполнения операции: 56 - 57 -Added – трекинг создан и помещён в базу 58 - 59 -Changed – трекинг изменён 60 - 61 -NotFound – трекинг не найден по uid 62 - 63 -Error – ошибка в работе метода 64 - 65 -Unknown – неизвестная ошибка 66 -)))|Added 67 -|TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере| 68 - 69 -Секция Errors содержит коллекцию строк ошибок. 70 - 71 -Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: 72 - 73 -|Название параметра|Тип параметра|Описание параметра|Пример 74 -|ErrorCode|**string**|Код ошибки| 75 -|ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.| 76 -|Status|**string**|Статус трекинга| 77 -|Descriptilon|**string**|Описание ошибки 78 - 79 -* ((( 80 -== [[DeleteAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] == 81 -))) 82 - 83 -Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения 84 - 85 -* ((( 86 -== [[GetANRPInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] == 87 -))) 88 - 89 -Получение информации по акту неремонтопригодности. 90 - 91 -* ((( 92 -== [[GetATOInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] == 93 -))) 94 - 95 -Получение информации по акту технического освидетельствования. 96 - 97 -* ((( 98 -== [[GetActionPlace>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] == 99 -))) 100 - 101 -Возвращает справочник мест ремонта. 102 - 103 -* ((( 104 -== [[GetAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] == 105 -))) 106 - 107 -Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения. 108 - 109 -* ((( 110 -== [[GetAttachmentKeys>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] == 111 -))) 112 - 113 -Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений. 114 - 115 -* ((( 116 -== [[GetAttachmentTypes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] == 117 -))) 118 - 119 -Возвращает список типов вложений 120 - 121 -* ((( 122 -== [[GetBrands>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]] == 123 -))) 124 - 125 -Возвращает список брендов в разрезе групп брендов. 126 - 127 -* ((( 128 -== [[GetCategIrisConditionCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisConditionCodes]] == 129 -))) 130 - 131 -Возвращает справочник Iris Код условий по бренду и категории модели. 132 - 133 -* ((( 134 -== [[GetCategIrisDefectCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisDefectCodes]] == 135 -))) 136 - 137 -Возвращает справочник Iris Код дефектов по бренду и категории модели. 138 - 139 -* ((( 140 -== [[GetCategIrisRepairCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisRepairCodes]] == 141 -))) 142 - 143 -Возвращает справочник Iris Код ремонтов по бренду и категории модели. 144 - 145 -* ((( 146 -== [[GetCategIrisSectionCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisSectionCodes]] == 147 -))) 148 - 149 -Возвращает справочник Iris Код секций по бренду и категории модели. 150 - 151 -* ((( 152 -== [[GetCategIrisSymptomCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisSymptomCodes]] == 153 -))) 154 - 155 -Возвращает справочник Iris Код симптомов по бренду и категории модели. 156 - 157 -* ((( 158 -== [[GetIrisCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetIrisCodes]] == 159 -))) 160 - 161 -Возвращает Iris коды в разрезе типов Iris кодов (ConditionCode, DefectCode, RepairCode, sectionCode, SymptomCode), категорий моделей и брендов (в рамках активных авторизаций по брендам) 162 - 163 -* ((( 164 -== [[GetModelCategories>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetModelCategories]] == 165 -))) 166 - 167 -Возвращает справочник категорий моделей. 168 - 169 -* ((( 170 -== [[GetOrderByAscKey>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderByAscKey]] == 171 -))) 172 - 173 -Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc) 174 - 175 -* ((( 176 -== [[GetOrderBySysKey>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]] == 177 -))) 178 - 179 -Возвращает трекинг по системному номеру (OrderNum). 180 - 181 -* ((( 182 -== [[GetOrderKeys>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderKeys]] == 183 -))) 184 - 185 -Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус. 186 - 187 -* ((( 188 -== [[GetRejectReasons>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetRejectReasons]] == 189 -))) 190 - 191 -Список причин отмены трекинга 192 - 193 -* ((( 194 -== [[GetSpRepairTypes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]] == 195 -))) 196 - 197 -Возвращает справочник типов ремонтов по группе брендов (MainBrandUid). 198 - 199 -* ((( 200 -== [[GetSpStatuses>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] == 201 -))) 202 - 203 -Возвращает список статусов трекинга. 204 - 205 -* ((( 206 -== [[GetTicket>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] == 207 -))) 208 - 209 -Получение бинарного идентификатора для аутентификации пользователя по логину и паролю. 210 - 211 -* ((( 212 -== [[GetTransportService>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTransportService]] == 213 -))) 214 - 215 -Возвращает справочник типов транспортировки по мету ремонта и бренду. 216 - 217 -* ((( 218 -== [[GetTransportZone>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTransportZone]] == 219 -))) 220 - 221 -Возврат справочника зон транспортировки. 222 - 223 -* ((( 224 -== [[SaveAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveAttachment]] == 225 -))) 226 - 227 -Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа 228 - 229 -* ((( 230 -== [[SaveOrder>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] == 231 -))) 232 - 233 -Создание/обновление трекинга. 234 - 235 235 = Порядок вызова методов и работы с сервисом = 236 236 237 237 1. Для начала работы требуется аутентифицироваться. Для этого нужно вызвать метод [[GetTicket>>path:#_heading=h.1fob9te]] с параметрами login и password и получить в ответ ticket. Он используются для вызова других методов сервиса. В качестве пользователя может использоваться любой созданный на сайте аккаунт с доступом к созданию трекинга. 238 238 1. Далее нужно заполнить справочники (классификаторы) вашего сервиса, чтобы передавать их в метод сохранения ремонта. Справочники заполняются вызовами соответствующих методов класса «Получение классификатора». 239 -1. Ремонт создаётся методом [[SaveOrder>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]].Любые изменения вносятся повторным вызовом этого метода. Метод возвращает в числе других параметров TrackingUid, необходим при сохранении вложений к трекингу [[SaveAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveAttachment]], получении информации по акту неремонтопригодности [[GetANRPInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] или акту технического освидетельствования [[GetATOInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]]. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода.43 +1. Ремонт создаётся методом SaveOrder. Любые изменения вносятся повторным вызовом этого метода. Метод возвращает в числе других параметров TrackingUid, необходим при сохранении вложений к трекингу [[SaveAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveAttachment]], получении информации по акту неремонтопригодности [[GetANRPInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] или акту технического освидетельствования [[GetATOInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]]. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода. 240 240 1. **Важно: ** 241 241 242 242 * Ремонт в статусе «ОТЧЕТ», «ОТМЕНЁН», «ОПЛАЧЕН» не может быть обновлён. ... ... @@ -250,6 +250,21 @@ 250 250 251 251 То есть при передачи новых данных по этим полям, они будут проигнорированы. 252 252 57 += Метод GetTicket = 58 + 59 +Получение бинарного идентификатора для аутентификации пользователя. 60 + 61 +**Входные параметры:** 62 + 63 +|(% style="width:173px" %)Название параметра|(% style="width:173px" %)Тип параметра|(% style="width:159px" %)Обязательный|(% style="width:253px" %)Описание параметра|(% style="width:225px" %)Пример 64 +|(% style="width:173px" %)Login|(% style="width:173px" %)**string**|(% style="width:159px" %)Да|(% style="width:253px" %)Логин пользователя|(% style="width:225px" %)Vasya 65 +|(% style="width:173px" %)Password|(% style="width:173px" %)**string**|(% style="width:159px" %)Да|(% style="width:253px" %)Пароль пользователя|(% style="width:225px" %)123456 66 + 67 +**Возвращаемое значение:** 68 + 69 +|Тип параметра|Описание параметра|Пример 70 +|string|Сессионный ключ|YOB7IG8UG687068 71 + 253 253 254 254 ))) 255 255