Интеграция с трекингом (API)

Версия 6.1 от Григорий Лепёшкин на 2023/12/21 15:04

Назначение API

Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения.

Список методов

Создание трекинга колл-центра.

Входные параметры:

Название параметраТип параметраОбяз.Описание параметра
ticketstringДаСессионный ключ
recordrecordДаструктура содержащая данные
Структура Record
Modelstring (50)ДаСтрока названия модели
OrderNumBrandstring (50)ДаНомер заявки колл-центра
SerialNumbstring (50)НетСерийный номер
DesRepairstring (3000)НетЗаявленная неисправность
RepairTypeUidguidНет

Тип ремонта  (связь с брендами (Default)). Значение берется из метода GetSpRepairTypes. Если не заполнено, то подставится «Клиентский гарантийный».

 

BrandUidguidДаБренд (торговая марка). Значение берётся из GetBrands.BrandUid
CountryServiceCenterstring (2)НетСтана АСЦ. Указывается страна в виде кода ALFA-2. Если страна найдена, то город будет сопоставляться с городами этой страны, иначе со страной пользователя колл-центра.
CityServiceCenterstring (255)НетГород АСЦ. Город подбирается по тексту и стране. Если город найден, то по городу и бренду  осуществляется поиск АСЦ. Если найден единственный АСЦ, то подставляется он иначе, если не единственный или если город не найден, то берется город пользователя колл-центра и в качестве АСЦ указывается пусто. Далее при редактировании данного трекинга на сайте, его не возможно сохранить с пустым АСЦ.   
CNamestring (255)НетИмя клиента
CSurnamestring (255)НетФамилия клиента
CPatronymicstring (255)НетОтчество клиента
CCitystring (255)НетГород клиента
CAddressstring (255)НетАдрес клиента
CHousestring (5)НетНомер дома клиента
CBuildstring (5)НетКорпус дома клиента
CFlatstring (5)НетНомер квартиры клиента
CMobTelstring (15)НетМобильный телефон клиента
Cemailstring (255)НетEmail клиента
UrlQuestionnairestringНетURL на анкету для прохождения опроса по завершению ремонта

Выходные параметры:

Название параметраТип параметраОписание параметраПример
TrackingUidguidУникальный идентификатор трекинга. Значение можно использовать для дальнейших вызовов метода SaveOrder, если необходимо обновить значения трекинга. 
SysNumstringСистемный номер трекинга (учётный номер ремонта в системе) 
StatusNamestringСтатус трекинга 
StatusUidguidUID статуса трекинга. Значение берётся из GetSpStatuses. 
ResultAdded or Changed or NotFound or Error or Unknown

Результат выполнения операции:

Added – трекинг создан и помещён в базу

Changed – трекинг изменён

NotFound – трекинг не найден по uid

Error – ошибка в работе метода

Unknown – неизвестная ошибка

Added
TrackingUristringСсылка на трекинг, которую можно открыть в браузере 

Секция Errors содержит коллекцию строк ошибок.

Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:

Название параметраТип параметраОписание параметраПример
ErrorCodestringКод ошибки 
ErrorLevelintУровень ошибки: 1-критичная, 3-предупреждение. 
StatusstringСтатус трекинга 
DescriptilonstringОписание ошибки

Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения

Получение информации по акту неремонтопригодности.

Получение информации по акту технического освидетельствования.

Возвращает справочник мест ремонта.

Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.

Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.

Возвращает список типов вложений

Возвращает список брендов в разрезе групп брендов.

Возвращает справочник Iris Код условий по бренду и категории модели.

Возвращает справочник Iris Код дефектов по бренду и категории модели.

Возвращает справочник Iris Код ремонтов по бренду и категории модели.

Возвращает справочник Iris Код секций по бренду и категории модели.

Возвращает справочник Iris Код симптомов по бренду и категории модели.

Возвращает Iris коды в разрезе типов Iris кодов (ConditionCode, DefectCode, RepairCode, sectionCode, SymptomCode), категорий моделей и брендов (в рамках активных авторизаций по брендам)

Возвращает справочник категорий моделей.

Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)

Возвращает трекинг по системному номеру (OrderNum).

Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.

Список причин отмены трекинга

Возвращает справочник типов ремонтов по группе брендов (MainBrandUid).

Возвращает список статусов трекинга.

Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.

Возвращает справочник типов транспортировки по мету ремонта и бренду.

Возврат справочника зон транспортировки.

Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа

Создание/обновление трекинга.

Порядок вызова методов и работы с сервисом

  1. Для начала работы требуется аутентифицироваться. Для этого нужно вызвать метод GetTicket с параметрами login и password и получить в ответ ticket. Он используются для вызова других методов сервиса. В качестве пользователя может использоваться любой созданный на сайте аккаунт с доступом к созданию трекинга.
  2. Далее нужно заполнить справочники (классификаторы) вашего сервиса, чтобы передавать их в метод сохранения ремонта. Справочники заполняются вызовами соответствующих методов класса «Получение классификатора».
  3. Ремонт создаётся методом SaveOrder. Любые изменения вносятся повторным вызовом этого метода. Метод возвращает в числе других параметров TrackingUid, необходим при сохранении вложений к трекингу SaveAttachment, получении информации по акту неремонтопригодности GetANRPInfo или акту технического освидетельствования GetATOInfo. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода.
  4. Важно: 
  • Ремонт в статусе «ОТЧЕТ», «ОТМЕНЁН», «ОПЛАЧЕН»  не может быть обновлён.
  • Ремонт в статусе «Ремонт начат» блокируется на изменение ряда полей:
    • ReceiveDate - Дата приёма в ремонт
    • Model - Модель
    • SerialNumb - Серийный номер
    • DesRepair - Заявленный дефект
    • OrderNumBrand - Номер заявки ИЦ
    • RepairTypeCurrent - Тип ремонта

То есть при передачи новых данных по этим полям, они будут проигнорированы.

 

Содержание
Теги:
Создал(а) Григорий Лепёшкин 2023/12/21 11:44