Исходный код вики Интеграция с трекингом (API)
Версия 5.1 от Григорий Лепёшкин на 2023/12/21 14:56
Скрыть последних авторов
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | (% class="row" %) |
| 2 | ((( | ||
| 3 | (% class="col-xs-12 col-sm-8" %) | ||
| 4 | ((( | ||
| |
2.1 | 5 | = Назначение API = |
| |
1.1 | 6 | |
| 7 | Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения. | ||
| 8 | |||
| |
2.1 | 9 | = Список методов = |
| |
1.1 | 10 | |
| 11 | * [[CreateTrackingCallCentr>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=CreateTrackingCallCentr]] - Создание трекинга колл-центра. | ||
| |
5.1 | 12 | |
| 13 | Входные параметры: | ||
| 14 | |||
| 15 | |Название параметра|Тип параметра|Обяз.|Описание параметра | ||
| 16 | |ticket|**string**|Да|Сессионный ключ | ||
| 17 | |record|**record**|Да|структура содержащая данные | ||
| 18 | |(% colspan="4" %)**Структура Record** | ||
| 19 | |Model|**string (50)**|Да|Строка названия модели | ||
| 20 | |OrderNumBrand|**string (50)**|Да|Номер заявки колл-центра | ||
| 21 | |SerialNumb|**string (50)**|Нет|Серийный номер | ||
| 22 | |DesRepair|**string (3000)**|Нет|Заявленная неисправность | ||
| 23 | |RepairTypeUid|**guid**|Нет|((( | ||
| 24 | Тип ремонта (связь с брендами (Default)). Значение берется из метода [[GetSpRepairTypes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]]. Если не заполнено, то подставится «Клиентский гарантийный». | ||
| 25 | |||
| 26 | |||
| 27 | ))) | ||
| 28 | |BrandUid|**guid**|Да|Бренд (торговая марка). Значение берётся из [[GetBrands>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]].BrandUid | ||
| 29 | |CountryServiceCenter|**string (2)**|Нет|Стана АСЦ. Указывается страна в виде кода ALFA-2. Если страна найдена, то город будет сопоставляться с городами этой страны, иначе со страной пользователя колл-центра. | ||
| 30 | |CityServiceCenter|**string (255)**|Нет|Город АСЦ. Город подбирается по тексту и стране. Если город найден, то по городу и бренду осуществляется поиск АСЦ. Если найден единственный АСЦ, то подставляется он иначе, если не единственный или если город не найден, то берется город пользователя колл-центра и в качестве АСЦ указывается пусто. Далее при редактировании данного трекинга на сайте, его не возможно сохранить с пустым АСЦ. | ||
| 31 | |CName|**string (255)**|Нет|Имя клиента | ||
| 32 | |CSurname|**string (255)**|Нет|Фамилия клиента | ||
| 33 | |CPatronymic|**string (255)**|Нет|Отчество клиента | ||
| 34 | |CCity|**string (255)**|Нет|Город клиента | ||
| 35 | |CAddress|**string (255)**|Нет|Адрес клиента | ||
| 36 | |CHouse|**string (5)**|Нет|Номер дома клиента | ||
| 37 | |CBuild|**string (5)**|Нет|Корпус дома клиента | ||
| 38 | |CFlat|**string (5)**|Нет|Номер квартиры клиента | ||
| 39 | |CMobTel|**string (15)**|Нет|Мобильный телефон клиента | ||
| 40 | |Cemail|**string (255)**|Нет|Email клиента | ||
| 41 | |UrlQuestionnaire|**string**|Нет|URL на анкету для прохождения опроса по завершению ремонта | ||
| 42 | |||
| 43 | Выходные параметры: | ||
| 44 | |||
| 45 | |Название параметра|Тип параметра|Описание параметра|Пример | ||
| 46 | |TrackingUid|**guid**|Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода [[SaveOrder>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]], если необходимо обновить значения трекинга.| | ||
| 47 | |SysNum|**string**|Системный номер трекинга (учётный номер ремонта в системе)| | ||
| 48 | |StatusName|**string**|Статус трекинга| | ||
| 49 | |StatusUid|**guid**|UID статуса трекинга. Значение берётся из [[GetSpStatuses>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]].| | ||
| 50 | |Result|**Added** or **Changed** or **NotFound** or **Error** or **Unknown**|((( | ||
| 51 | Результат выполнения операции: | ||
| 52 | |||
| 53 | Added – трекинг создан и помещён в базу | ||
| 54 | |||
| 55 | Changed – трекинг изменён | ||
| 56 | |||
| 57 | NotFound – трекинг не найден по uid | ||
| 58 | |||
| 59 | Error – ошибка в работе метода | ||
| 60 | |||
| 61 | Unknown – неизвестная ошибка | ||
| 62 | )))|Added | ||
| 63 | |TrackingUri|**string**|Ссылка на трекинг, которую можно открыть в браузере| | ||
| 64 | |||
| 65 | Секция Errors содержит коллекцию строк ошибок. | ||
| 66 | |||
| 67 | Секция ValidationErrors содержит коллекцию ErrorItem следующего вида: | ||
| 68 | |||
| 69 | |Название параметра|Тип параметра|Описание параметра|Пример | ||
| 70 | |ErrorCode|**string**|Код ошибки| | ||
| 71 | |ErrorLevel|**int**|Уровень ошибки: 1-критичная, 3-предупреждение.| | ||
| 72 | |Status|**string**|Статус трекинга| | ||
| 73 | |Descriptilon|**string**|Описание ошибки | ||
| 74 | |||
| |
1.1 | 75 | * [[DeleteAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] -Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения |
| 76 | * [[GetANRPInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] - Получение информации по акту неремонтопригодности. | ||
| 77 | * [[GetATOInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] - Получение информации по акту технического освидетельствования. | ||
| 78 | * [[GetActionPlace>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetActionPlace]] - Возвращает справочник мест ремонта. | ||
| 79 | * [[GetAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachment]] - Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения. | ||
| 80 | * [[GetAttachmentKeys>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentKeys]] - Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений. | ||
| 81 | * [[GetAttachmentTypes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetAttachmentTypes]] - Возвращает список типов вложений | ||
| 82 | * [[GetBrands>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetBrands]] - Возвращает список брендов в разрезе групп брендов. | ||
| 83 | * [[GetCategIrisConditionCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisConditionCodes]] - Возвращает справочник Iris Код условий по бренду и категории модели. | ||
| 84 | * [[GetCategIrisDefectCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisDefectCodes]] - Возвращает справочник Iris Код дефектов по бренду и категории модели. | ||
| 85 | * [[GetCategIrisRepairCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisRepairCodes]] - Возвращает справочник Iris Код ремонтов по бренду и категории модели. | ||
| 86 | * [[GetCategIrisSectionCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisSectionCodes]] - Возвращает справочник Iris Код секций по бренду и категории модели. | ||
| 87 | * [[GetCategIrisSymptomCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetCategIrisSymptomCodes]] - Возвращает справочник Iris Код симптомов по бренду и категории модели. | ||
| 88 | * [[GetIrisCodes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetIrisCodes]] - Возвращает Iris коды в разрезе типов Iris кодов (ConditionCode, DefectCode, RepairCode, sectionCode, SymptomCode), категорий моделей и брендов (в рамках активных авторизаций по брендам) | ||
| 89 | * [[GetModelCategories>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetModelCategories]] - Возвращает справочник категорий моделей. | ||
| 90 | * [[GetOrderByAscKey>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderByAscKey]] - Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc) | ||
| 91 | * [[GetOrderBySysKey>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderBySysKey]] - Возвращает трекинг по системному номеру (OrderNum). | ||
| 92 | * [[GetOrderKeys>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetOrderKeys]] - Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус. | ||
| 93 | * [[GetRejectReasons>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetRejectReasons]] - Список причин отмены трекинга | ||
| 94 | * [[GetSpRepairTypes>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpRepairTypes]] - Возвращает справочник типов ремонтов по группе брендов (MainBrandUid). | ||
| 95 | * [[GetSpStatuses>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetSpStatuses]] - Возвращает список статусов трекинга. | ||
| 96 | * [[GetTicket>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] - Получение бинарного идентификатора для аутентификации пользователя по логину и паролю. | ||
| 97 | * [[GetTransportService>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTransportService]] - Возвращает справочник типов транспортировки по мету ремонта и бренду. | ||
| 98 | * [[GetTransportZone>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTransportZone]] - Возврат справочника зон транспортировки. | ||
| 99 | * [[SaveAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveAttachment]] - Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа | ||
| 100 | * [[SaveOrder>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] - Создание/обновление трекинга. | ||
| 101 | |||
| |
2.1 | 102 | = Порядок вызова методов и работы с сервисом = |
| |
1.1 | 103 | |
| 104 | 1. Для начала работы требуется аутентифицироваться. Для этого нужно вызвать метод [[GetTicket>>path:#_heading=h.1fob9te]] с параметрами login и password и получить в ответ ticket. Он используются для вызова других методов сервиса. В качестве пользователя может использоваться любой созданный на сайте аккаунт с доступом к созданию трекинга. | ||
| 105 | 1. Далее нужно заполнить справочники (классификаторы) вашего сервиса, чтобы передавать их в метод сохранения ремонта. Справочники заполняются вызовами соответствующих методов класса «Получение классификатора». | ||
| |
4.1 | 106 | 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]]. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода. |
| |
1.1 | 107 | 1. **Важно: ** |
| 108 | |||
| 109 | * Ремонт в статусе «ОТЧЕТ», «ОТМЕНЁН», «ОПЛАЧЕН» не может быть обновлён. | ||
| 110 | * Ремонт в статусе «Ремонт начат» блокируется на изменение ряда полей: | ||
| 111 | ** ReceiveDate - Дата приёма в ремонт | ||
| 112 | ** Model - Модель | ||
| 113 | ** SerialNumb - Серийный номер | ||
| 114 | ** DesRepair - Заявленный дефект | ||
| 115 | ** OrderNumBrand - Номер заявки ИЦ | ||
| 116 | ** RepairTypeCurrent - Тип ремонта | ||
| 117 | |||
| 118 | То есть при передачи новых данных по этим полям, они будут проигнорированы. | ||
| |
2.1 | 119 | |
| 120 | |||
| |
1.1 | 121 | ))) |
| 122 | |||
| 123 | (% class="col-xs-12 col-sm-4" %) | ||
| 124 | ((( | ||
| 125 | {{box title="**Содержание**"}} | ||
| 126 | {{toc/}} | ||
| 127 | {{/box}} | ||
| 128 | ))) | ||
| 129 | ))) |