Исходный код вики Интеграция с трекингом (API)
Версия 3.1 от Григорий Лепёшкин на 2023/12/21 11:50
Скрыть последних авторов
| 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]] - Создание трекинга колл-центра. | ||
| 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]] - Создание/обновление трекинга. | ||
| 38 | |||
| |
2.1 | 39 | = Порядок вызова методов и работы с сервисом = |
| |
1.1 | 40 | |
| 41 | 1. Для начала работы требуется аутентифицироваться. Для этого нужно вызвать метод [[GetTicket>>path:#_heading=h.1fob9te]] с параметрами login и password и получить в ответ ticket. Он используются для вызова других методов сервиса. В качестве пользователя может использоваться любой созданный на сайте аккаунт с доступом к созданию трекинга. | ||
| 42 | 1. Далее нужно заполнить справочники (классификаторы) вашего сервиса, чтобы передавать их в метод сохранения ремонта. Справочники заполняются вызовами соответствующих методов класса «Получение классификатора». | ||
| 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]]. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода. | ||
| 44 | 1. **Важно: ** | ||
| 45 | |||
| 46 | * Ремонт в статусе «ОТЧЕТ», «ОТМЕНЁН», «ОПЛАЧЕН» не может быть обновлён. | ||
| 47 | * Ремонт в статусе «Ремонт начат» блокируется на изменение ряда полей: | ||
| 48 | ** ReceiveDate - Дата приёма в ремонт | ||
| 49 | ** Model - Модель | ||
| 50 | ** SerialNumb - Серийный номер | ||
| 51 | ** DesRepair - Заявленный дефект | ||
| 52 | ** OrderNumBrand - Номер заявки ИЦ | ||
| 53 | ** RepairTypeCurrent - Тип ремонта | ||
| 54 | |||
| 55 | То есть при передачи новых данных по этим полям, они будут проигнорированы. | ||
| |
2.1 | 56 | |
| |
3.1 | 57 | = Метод [[GetTicket>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetTicket]] = |
| |
2.1 | 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 | |||
| 72 | |||
| |
1.1 | 73 | ))) |
| 74 | |||
| 75 | (% class="col-xs-12 col-sm-4" %) | ||
| 76 | ((( | ||
| 77 | {{box title="**Содержание**"}} | ||
| 78 | {{toc/}} | ||
| 79 | {{/box}} | ||
| 80 | ))) | ||
| 81 | ))) |