Интеграция с трекингом (API)
Версия 5.1 от Григорий Лепёшкин на 2023/12/21 14:56
Назначение API
Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения.
Список методов
- CreateTrackingCallCentr - Создание трекинга колл-центра.
Входные параметры:
| Название параметра | Тип параметра | Обяз. | Описание параметра |
| ticket | string | Да | Сессионный ключ |
| record | record | Да | структура содержащая данные |
| Структура Record | |||
| Model | string (50) | Да | Строка названия модели |
| OrderNumBrand | string (50) | Да | Номер заявки колл-центра |
| SerialNumb | string (50) | Нет | Серийный номер |
| DesRepair | string (3000) | Нет | Заявленная неисправность |
| RepairTypeUid | guid | Нет | Тип ремонта (связь с брендами (Default)). Значение берется из метода GetSpRepairTypes. Если не заполнено, то подставится «Клиентский гарантийный».
|
| BrandUid | guid | Да | Бренд (торговая марка). Значение берётся из GetBrands.BrandUid |
| CountryServiceCenter | string (2) | Нет | Стана АСЦ. Указывается страна в виде кода ALFA-2. Если страна найдена, то город будет сопоставляться с городами этой страны, иначе со страной пользователя колл-центра. |
| CityServiceCenter | string (255) | Нет | Город АСЦ. Город подбирается по тексту и стране. Если город найден, то по городу и бренду осуществляется поиск АСЦ. Если найден единственный АСЦ, то подставляется он иначе, если не единственный или если город не найден, то берется город пользователя колл-центра и в качестве АСЦ указывается пусто. Далее при редактировании данного трекинга на сайте, его не возможно сохранить с пустым АСЦ. |
| CName | string (255) | Нет | Имя клиента |
| CSurname | string (255) | Нет | Фамилия клиента |
| CPatronymic | string (255) | Нет | Отчество клиента |
| CCity | string (255) | Нет | Город клиента |
| CAddress | string (255) | Нет | Адрес клиента |
| CHouse | string (5) | Нет | Номер дома клиента |
| CBuild | string (5) | Нет | Корпус дома клиента |
| CFlat | string (5) | Нет | Номер квартиры клиента |
| CMobTel | string (15) | Нет | Мобильный телефон клиента |
| Cemail | string (255) | Нет | Email клиента |
| UrlQuestionnaire | string | Нет | URL на анкету для прохождения опроса по завершению ремонта |
Выходные параметры:
| Название параметра | Тип параметра | Описание параметра | Пример |
| TrackingUid | guid | Уникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода SaveOrder, если необходимо обновить значения трекинга. | |
| SysNum | string | Системный номер трекинга (учётный номер ремонта в системе) | |
| StatusName | string | Статус трекинга | |
| StatusUid | guid | UID статуса трекинга. Значение берётся из GetSpStatuses. | |
| Result | Added or Changed or NotFound or Error or Unknown | Результат выполнения операции: Added – трекинг создан и помещён в базу Changed – трекинг изменён NotFound – трекинг не найден по uid Error – ошибка в работе метода Unknown – неизвестная ошибка | Added |
| TrackingUri | string | Ссылка на трекинг, которую можно открыть в браузере |
Секция Errors содержит коллекцию строк ошибок.
Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
| Название параметра | Тип параметра | Описание параметра | Пример |
| ErrorCode | string | Код ошибки | |
| ErrorLevel | int | Уровень ошибки: 1-критичная, 3-предупреждение. | |
| Status | string | Статус трекинга | |
| Descriptilon | string | Описание ошибки |
- DeleteAttachment -Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
- GetANRPInfo - Получение информации по акту неремонтопригодности.
- GetATOInfo - Получение информации по акту технического освидетельствования.
- GetActionPlace - Возвращает справочник мест ремонта.
- GetAttachment - Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
- GetAttachmentKeys - Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
- GetAttachmentTypes - Возвращает список типов вложений
- GetBrands - Возвращает список брендов в разрезе групп брендов.
- GetCategIrisConditionCodes - Возвращает справочник Iris Код условий по бренду и категории модели.
- GetCategIrisDefectCodes - Возвращает справочник Iris Код дефектов по бренду и категории модели.
- GetCategIrisRepairCodes - Возвращает справочник Iris Код ремонтов по бренду и категории модели.
- GetCategIrisSectionCodes - Возвращает справочник Iris Код секций по бренду и категории модели.
- GetCategIrisSymptomCodes - Возвращает справочник Iris Код симптомов по бренду и категории модели.
- GetIrisCodes - Возвращает Iris коды в разрезе типов Iris кодов (ConditionCode, DefectCode, RepairCode, sectionCode, SymptomCode), категорий моделей и брендов (в рамках активных авторизаций по брендам)
- GetModelCategories - Возвращает справочник категорий моделей.
- GetOrderByAscKey - Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
- GetOrderBySysKey - Возвращает трекинг по системному номеру (OrderNum).
- GetOrderKeys - Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
- GetRejectReasons - Список причин отмены трекинга
- GetSpRepairTypes - Возвращает справочник типов ремонтов по группе брендов (MainBrandUid).
- GetSpStatuses - Возвращает список статусов трекинга.
- GetTicket - Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
- GetTransportService - Возвращает справочник типов транспортировки по мету ремонта и бренду.
- GetTransportZone - Возврат справочника зон транспортировки.
- SaveAttachment - Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
- SaveOrder - Создание/обновление трекинга.
Порядок вызова методов и работы с сервисом
- Для начала работы требуется аутентифицироваться. Для этого нужно вызвать метод GetTicket с параметрами login и password и получить в ответ ticket. Он используются для вызова других методов сервиса. В качестве пользователя может использоваться любой созданный на сайте аккаунт с доступом к созданию трекинга.
- Далее нужно заполнить справочники (классификаторы) вашего сервиса, чтобы передавать их в метод сохранения ремонта. Справочники заполняются вызовами соответствующих методов класса «Получение классификатора».
- Ремонт создаётся методом SaveOrder. Любые изменения вносятся повторным вызовом этого метода. Метод возвращает в числе других параметров TrackingUid, необходим при сохранении вложений к трекингу SaveAttachment, получении информации по акту неремонтопригодности GetANRPInfo или акту технического освидетельствования GetATOInfo. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода.
- Важно:
- Ремонт в статусе «ОТЧЕТ», «ОТМЕНЁН», «ОПЛАЧЕН» не может быть обновлён.
- Ремонт в статусе «Ремонт начат» блокируется на изменение ряда полей:
- ReceiveDate - Дата приёма в ремонт
- Model - Модель
- SerialNumb - Серийный номер
- DesRepair - Заявленный дефект
- OrderNumBrand - Номер заявки ИЦ
- RepairTypeCurrent - Тип ремонта
То есть при передачи новых данных по этим полям, они будут проигнорированы.