Интеграция с трекингом (API)
Версия 23.3 от Дмитрий Семёнов на 2025/03/19 14:59
Назначение API
Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения.
Для использования API необходимо пройти аутентификацию с помощью метода `GetTicket` для получения сессионного ключа, который будет использоваться для всех последующих запросов.
Список методов
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) | Нет | Мобильный телефон клиента |
| CWorkTel | string (15) | Нет | Рабочий телефон клиента |
| CHomeTel | string (15) | Нет | Домашний телефон клиента |
| Cemail | string (255) | Нет | Email клиента |
| PurchDate | datetime | Нет | Дата продажи |
| 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 – трекинг создан и помещён в базу | Added |
| TrackingUri | string | Ссылка на трекинг, которую можно открыть в браузере |
Сообщения об ошибках
Секция Errors содержит коллекцию строк ошибок.
Сообщения о валидационных проверках
Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
| Название параметра | Тип параметра | Описание параметра | Пример |
| ErrorCode | string | Код ошибки | |
| ErrorLevel | int | Уровень ошибки: 1-критичная, 3-предупреждение. | |
| Status | string | Статус трекинга | |
| Descriptilon | string | Описание ошибки |
DeleteAttachment
Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
Входные параметры
| Название параметра | Тип параметра | Описание параметра | Пример | |
| numberKey | string | Идентификатор вложения | ||
| typeUid | string | Идентификатор типа вложения (GUID) |
Выходные параметры
Возвращает логическое значение об успешности выполнения операции
Получение информации по акту неремонтопригодности.
Получение информации по акту технического освидетельствования.
Возвращает справочник мест ремонта.
Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
Возвращает список типов вложений
Возвращает список брендов в разрезе групп брендов.
Входные параметры:
Секция message
| Название параметра | Тип параметра | Обяз? | Описание параметра | Пример |
| ticket | string | Да | Сессионный ключ | Vasya |
Выходные параметры:
Возвращает коллекцию BrandItem следующего вида:
| Название параметра | Тип параметра | Описание параметра | Пример |
| MainBrandUid | guid | Идентификатор группы брендов | 7e86699d-50a4-4b5d-8627-f8c8da56f053 |
| MainBrandName | string (50) | Наименование группы брендов | PHILIPS |
| BrandUid | guid | Идентификатор бренда модели | 4f94a810-2f0d-48a0-bbd0-c9617390efd3 |
| BrandName | string (50) | Наименование бренда модели | PHILIPS |
Возвращает справочник Iris Код условий по бренду и категории модели.
Возвращает справочник Iris Код дефектов по бренду и категории модели.
Возвращает справочник Iris Код ремонтов по бренду и категории модели.
Возвращает справочник Iris Код секций по бренду и категории модели.
Возвращает справочник Iris Код симптомов по бренду и категории модели.
Возвращает Iris коды в разрезе типов Iris кодов (ConditionCode, DefectCode, RepairCode, sectionCode, SymptomCode), категорий моделей и брендов (в рамках активных авторизаций по брендам)
Возвращает справочник категорий моделей.
Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
Входные параметры:
| Название параметра | Тип параметра | Обяз? | Описание параметра | Пример |
| ticket | string | Да | Сессионный ключ | YOB7IG8UG687068 |
numberKey
| string | Да | Собственный номер ремонта АСЦ. | 1.0.0.0 |
Выходные параметры:
Секция Tracking
| Название параметра | Тип параметра | Описание параметра | Пример |
| uid | guid | Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга. | 6e18064e-1cd3-4207-8ebe-08c4417db2be |
| Brand | guid | Группа брендов. Значение берётся из поля MainBrandUid из GetBrands. | b457927a-766e-44b1-a79d-508adee3a915 |
| Model | string (50) | Строка названия модели | 121 |
| OrderNum | string (50) | Строка номера ремонта | 0000018 |
| OrderNumBrand | string (50) | Номер заявки колл-центра | |
| ReceiveDate | datetime | Дата получения товара в ремонт | |
| ReadyDate | datetime | Дата готовности | |
| ReadyOutDate | datetime | Дата готовности к выдаче | |
| OutDate | datetime | Дата выдачи | |
| PurchDate | datetime | Дата покупки | |
| SerialNumb | string (50) | Серийный номер | |
| ProductNumb | string (50) | Продуктовый номер | |
| EditDate | datetime | Дата редактирования (будет заменена на текущую) | 2023-04-07T18:16:10.783 |
| TransportService | guid | Вид транспортировки. Значение берётся из GetTransportService. | f34fa37d-b678-469d-9129-6ac9d9d270f7 |
| PlanTransportDate | datetime | Плановая дата доставки | |
| Status | guid | Статус. Значение берётся из GetSpStatuses. | 51deb04d-b307-4efc-826a-2d0e3d151d1d |
| MasterASC | string (255) | ФИО мастера | |
| CreateDate | datetime | Дата создания (в первый раз будет заменена на текущую) | 2023-04-03T16:56:20.74 |
| ComplectPack | int | Наличие коробки | |
| ComplectWarr | int | Наличие гарантийного талона | |
| ComplectCheck | int | Наличие чека | |
| PlanMasterDate | datetime | Планируемая дата выезда | |
| IsExpRep | boolean | Флаг экспресс-ремонта | |
| ServiceBulletin | string (255) | Сервисный бюллетень | |
| ActionPlace | guid | Место ремонта. Значение берётся из GetActionPlace. | 87da8c9b-61d8-4db0-825b-9c39adf1f50b |
| DesRepair | string (3000) | Заявленная неисправность | test |
| DescriptionCC | string (3000) | Результат диагностики оператором Call Центра | |
| DescriptionCompCent | string (3000) | Резюме центра компетенции | |
| DiagnosticResult | string (3000) | Результат диагностики | |
| Section | string (3) | Код секции. Значение берётся из GetCategIrisSectionCodes. | |
| Condition | string (3) | Код условия. Значение берётся из GetCategIrisConditionCodes. | |
| Symptom | string (3) | Код симптома. Значение берётся из GetCategIrisSymptomCodes. | |
| Defect | string (3) | Код дефекта. Значение берётся из GetCategIrisDefectCodes. | |
| Repair | string (3) | Код ремонта. Значение берётся из GetCategIrisRepairCodes. | |
| LocationCode | string (50) | Позиционный номер | |
| DName | string (255) | Наименование дилера | |
| DCity | string (255) | Город дилера | |
| DAddress | string (255) | Адрес дилера | |
| DTel | string (11) | Телефон дилера | |
| Demail | string (255) | Email дилера | |
| DComments | string (500) | Дополнительная информация дилера | |
| CName | string (255) | Имя клиента | |
| CSurname | string (255) | Фамилия клиента | |
| CPatronymic | string (255) | Отчество клиента | |
| CCity | string (255) | Город клиента | |
| CAddress | string (255) | Адрес клиента | |
| CHouse | string (5) | Номер дома клиента | |
| CBuild | string (5) | Корпус клиента | |
| CFlat | string (5) | Номер квартиры клиента | |
| CHomeTel | string (11) | Домашний телефон клиента | |
| CWorkTel | string (11) | Рабочий телефон клиента | |
| CMobTel | string (13) | Мобильный телефон клиента | |
| Cemail | string (255) | Email клиента | |
| CComments | string (500) | Дополнительная информация клиента | |
| CLift | int | Наличие лифта в доме клиента | |
| CDomofon | string (50) | Код домофона у клиента | |
| OrderNumAsc | string (50) | Номер ремонта в системе АСЦ | |
| StartRepairDate | datetime | Дата начала ремонта АСЦ | |
| RegularSWnumberIN | string (255) | Версия прошивки "Main SW" при поступлении в ремонт | |
| RegularSWnumberOUT | string (255) | Версия прошивки "Main SW" при выдаче из ремонта | |
| StandBySWnumberIN | string (255) | Версия прошивки "Stand By SW" при поступлении в ремонт | |
| StandBySWnumberOUT | string (255) | Версия прошивки "Stand By" при выдаче из ремонта | |
ConditionDescr
| string (255) | Описание Iris кода условия | 1-Постоянно |
| RepairTypeCurrent | guid | Тип ремонта текущий (связь с брендами (Default)) | b7a77d5a-e95a-11d9-b44e-000476de6b1e |
| RepairTypeStart | guid | Тип ремонта начальный (связь с брендами (Default)) | |
| TransportZone | guid | Зона транспортировки. Значение берётся из GetTransportZone. | 85df2056-e60f-4bc1-a21c-17c9f6c9241a |
| UidNRP | guid | Uid акта НРП | |
| RealBrand | guid | Бренд (торговая марка). Значение берётся из GetBrands. | b8a3f06b-cacf-4a9b-b3f7-089c266ea654 |
IWS
| string (255) | Номер IWS | b8a3f06b-cacf-4a9b-b3f7-089c266ea654 |
| RegionUid | guid | Город АСЦ. | |
| Recommendation | string (3000) | Рекомендации мастера по эксплуатации | |
| IMEI1 | string (255) | IMEI1 | |
| IMEI2 | string (255) | IMEI2 | |
| IMEI3 | string (255) | IMEI3 | |
| IMEI4 | string (255) | IMEI4 | |
| IMEI1NEW | string (255) | IMEI1 новый | |
| IMEI2NEW | string (255) | IMEI2 новый | |
| IMEI3NEW | string (255) | IMEI3 новый | |
| IMEI4NEW | string (255) | IMEI4 новый | |
| RepairLevel | string (300) | Уровень ремонта |
Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
| Название параметра | Тип параметра | Описание параметра | Пример |
| uid | guid | Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга. | |
| CreateDate | datetime | Дата создания (будет заменена на текущую) | |
| PartNumber | string (100) | ПартНомер | |
| PartName | string (255) | Наименование детали | |
| Price | decimal | Цена отгрузки | |
| Qnt | int | Количество | |
| Compensate | decimal | Размер компенсации для ASC | |
| ASCOrderNo | string (100) | № заказа ACЦ (ссылка на заказ) | |
| SPOrderNo | string (100) | № заявки з/ч (проверка при создании акта НРП) | |
| OrderCreate | datetime | Дата заказа запчасти | |
| PrognoseDate | datetime | Ожидаемая дата получения з/ч | |
| OrderUid | guid | Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода SaveOrder. | |
| AscItemKey | string (50) | Внутренний ID детали АСЦ | |
| TypeOrder | guid | Тип заказчика, в основном пустой или АСЦ | 9314B01D-3D61-426C-BCAF-BFDEF25AAA56 |
| InvoiceNum | string (50) | Номер накладной | |
| InvoiceDate | datetime | Дата накладной | |
| InvoiceRef | guid | Ссылка на позицию в накладной. Не используется в данное время | |
| AscStore | int | =1, если деталь получена АСЦ не у провайдера, а со стороны =0, если получена АСЦ у провайдера. Возможность указывать детали своего склада зависит от настроек авторизации по бренду. | |
| Section | string (3) | Код секции. Значение берётся из GetCategIrisSectionCodes. | |
| Condition | string (3) | Код условия. Значение берётся из GetCategIrisConditionCodes. | |
| Symptom | string (3) | Код симптома. Значение берётся из GetCategIrisSymptomCodes. | |
| Defect | string (3) | Код дефекта. Значение берётся из GetCategIrisDefectCodes. | |
| Repair | string (3) | Код ремонта. Значение берётся из GetCategIrisRepairCodes. | |
| LocationCode | string (50) | Позиционный номер | |
| EditDate | datetime | Дата редактирования (будет заменена на текущую) | |
| EditUser | guid | Идентификатор пользователя | |
| ProblemPartSerial | string (255) | Серийный номер неисправной детали | |
| SetupPartSerial | string (255) | Серийный номер установленной детали |
Секция Payment
| Название параметра | Тип параметра | Описание параметра | Пример |
| uid | guid | Идентификатор заказа | 00000000-0000-0000-0000-000000000000 |
| Labor | decimal | Стоимость работы | |
| BonusASC | decimal | Бонус АСЦ | |
| Handling | decimal | Фиксированный тариф провайдера | |
| BonusCSP | decimal | Переменное вознаграждение провайдера | |
| BonusCSPPercent | decimal | Процент (% от тарифа) на момент формирования инвойса | |
| SU | decimal | Оплата доставки з/ч провайдера | |
| Transport | decimal | Оплата транспортировки/выезда | |
| SparePartsASC | decimal | Сумма компенсации з/ч АСЦ | |
| SparePartsCSP | decimal | Сумма компенсации з/ч провайдера | |
| AdditionalLabor | decimal | Оплата дополнительных работ АСЦ | |
| ASCSumm | decimal | Итого оплата АСЦ | |
| CSPSumm | decimal | Итого оплата провайдера | |
| TotalSumm | decimal | Итого сумма отплаты | |
| LaborCSP | decimal | Стоимость работы провайдера | |
| LaborPSU | decimal | Стоимость ремонта PSU | |
| LaborSSB | decimal | Стоимость ремонта SSB | |
| AdditionalLaborTotal | decimal | Всего стоимость дополнительных работ | |
| BonusASCPercent | decimal | Процент бонусов АСЦ | |
| SparePartsTotal | decimal | Всего стоимость з/ч | |
| AdditionalLaborDescr | String (1000) | Описание дополнительных работ |
Отдельный параметр
| Название параметра | Тип параметра | Описание параметра | Пример |
| RefUri | string | Ссылка на трекинг, которую можно открыть в браузере |
Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
| Название параметра | Тип параметра | Описание параметра | Пример |
| ErrorCode | string | Код ошибки | 43 |
| ErrorLevel | int | Уровень ошибки: 1-критичная, 3-предупреждение. | 1 |
| Status | string | Статус трекинга | |
| Descriptilon | string | Описание ошибки | Для продолжения ремонта необходимо ввести, по крайней мере, одну запасную часть |
Возвращает трекинг по системному номеру (OrderNum).
Входные параметры:
| Название параметра | Тип параметра | Обяз? | Описание параметра | Пример |
| ticket | string | Да | Сессионный ключ | YOB7IG8UG687068 |
numberKey
| string | Да | Системный номер ремонта. OrderNum секции трекинг. | 1.0.0.0 |
Выходные параметры:
Секция Tracking
| Название параметра | Тип параметра | Описание параметра | Пример |
| uid | guid | Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга. | 6e18064e-1cd3-4207-8ebe-08c4417db2be |
| Brand | guid | Группа брендов. Значение берётся из поля MainBrandUid из GetBrands. | b457927a-766e-44b1-a79d-508adee3a915 |
| Model | string (50) | Строка названия модели | 121 |
| OrderNum | string (50) | Строка номера ремонта | 0000018 |
| OrderNumBrand | string (50) | Номер заявки колл-центра | |
| ReceiveDate | datetime | Дата получения товара в ремонт | |
| ReadyDate | datetime | Дата готовности | |
| ReadyOutDate | datetime | Дата готовности к выдаче | |
| OutDate | datetime | Дата выдачи | |
| PurchDate | datetime | Дата покупки | |
| SerialNumb | string (50) | Серийный номер | |
| ProductNumb | string (50) | Продуктовый номер | |
| EditDate | datetime | Дата редактирования (будет заменена на текущую) | 2023-04-07T18:16:10.783 |
| TransportService | guid | Вид транспортировки. Значение берётся из GetTransportService. | f34fa37d-b678-469d-9129-6ac9d9d270f7 |
| PlanTransportDate | datetime | Плановая дата доставки | |
| Status | guid | Статус. Значение берётся из GetSpStatuses. | 51deb04d-b307-4efc-826a-2d0e3d151d1d |
| MasterASC | string (255) | ФИО мастера | |
| CreateDate | datetime | Дата создания (в первый раз будет заменена на текущую) | 2023-04-03T16:56:20.74 |
| ComplectPack | int | Наличие коробки | |
| ComplectWarr | int | Наличие гарантийного талона | |
| ComplectCheck | int | Наличие чека | |
| PlanMasterDate | datetime | Планируемая дата выезда | |
| IsExpRep | boolean | Флаг экспресс-ремонта | |
| ServiceBulletin | string (255) | Сервисный бюллетень | |
| ActionPlace | guid | Место ремонта. Значение берётся из GetActionPlace. | 87da8c9b-61d8-4db0-825b-9c39adf1f50b |
| DesRepair | string (3000) | Заявленная неисправность | test |
| DescriptionCC | string (3000) | Результат диагностики оператором Call Центра | |
| DescriptionCompCent | string (3000) | Резюме центра компетенции | |
| DiagnosticResult | string (3000) | Результат диагностики | |
| Section | string (3) | Код секции. Значение берётся из GetCategIrisSectionCodes. | |
| Condition | string (3) | Код условия. Значение берётся из GetCategIrisConditionCodes. | |
| Symptom | string (3) | Код симптома. Значение берётся из GetCategIrisSymptomCodes. | |
| Defect | string (3) | Код дефекта. Значение берётся из GetCategIrisDefectCodes. | |
| Repair | string (3) | Код ремонта. Значение берётся из GetCategIrisRepairCodes. | |
| LocationCode | string (50) | Позиционный номер | |
| DName | string (255) | Наименование дилера | |
| DCity | string (255) | Город дилера | |
| DAddress | string (255) | Адрес дилера | |
| DTel | string (11) | Телефон дилера | |
| Demail | string (255) | Email дилера | |
| DComments | string (500) | Дополнительная информация дилера | |
| CName | string (255) | Имя клиента | |
| CSurname | string (255) | Фамилия клиента | |
| CPatronymic | string (255) | Отчество клиента | |
| CCity | string (255) | Город клиента | |
| CAddress | string (255) | Адрес клиента | |
| CHouse | string (5) | Номер дома клиента | |
| CBuild | string (5) | Корпус клиента | |
| CFlat | string (5) | Номер квартиры клиента | |
| CHomeTel | string (11) | Домашний телефон клиента | |
| CWorkTel | string (11) | Рабочий телефон клиента | |
| CMobTel | string (13) | Мобильный телефон клиента | |
| Cemail | string (255) | Email клиента | |
| CComments | string (500) | Дополнительная информация клиента | |
| CLift | int | Наличие лифта в доме клиента | |
| CDomofon | string (50) | Код домофона у клиента | |
| OrderNumAsc | string (50) | Номер ремонта в системе АСЦ | |
| StartRepairDate | datetime | Дата начала ремонта АСЦ | |
| RegularSWnumberIN | string (255) | Версия прошивки "Main SW" при поступлении в ремонт | |
| RegularSWnumberOUT | string (255) | Версия прошивки "Main SW" при выдаче из ремонта | |
| StandBySWnumberIN | string (255) | Версия прошивки "Stand By SW" при поступлении в ремонт | |
| StandBySWnumberOUT | string (255) | Версия прошивки "Stand By" при выдаче из ремонта | |
ConditionDescr
| string (255) | Описание Iris кода условия | 1-Постоянно |
| RepairTypeCurrent | guid | Тип ремонта текущий (связь с брендами (Default)) | b7a77d5a-e95a-11d9-b44e-000476de6b1e |
| RepairTypeStart | guid | Тип ремонта начальный (связь с брендами (Default)) | |
| TransportZone | guid | Зона транспортировки. Значение берётся из GetTransportZone. | 85df2056-e60f-4bc1-a21c-17c9f6c9241a |
| UidNRP | guid | Uid акта НРП | |
| RealBrand | guid | Бренд (торговая марка). Значение берётся из GetBrands. | b8a3f06b-cacf-4a9b-b3f7-089c266ea654 |
IWS
| string (255) | Номер IWS | b8a3f06b-cacf-4a9b-b3f7-089c266ea654 |
| RegionUid | guid | Город АСЦ. | |
| Recommendation | string (3000) | Рекомендации мастера по эксплуатации | |
| IMEI1 | string (255) | IMEI1 | |
| IMEI2 | string (255) | IMEI2 | |
| IMEI3 | string (255) | IMEI3 | |
| IMEI4 | string (255) | IMEI4 | |
| IMEI1NEW | string (255) | IMEI1 новый | |
| IMEI2NEW | string (255) | IMEI2 новый | |
| IMEI3NEW | string (255) | IMEI3 новый | |
| IMEI4NEW | string (255) | IMEI4 новый | |
| RepairLevel | string (300) | Уровень ремонта |
Подсекция Parts секции Tracking состоит из коллекции типа PartRecord следующего формата:
| Название параметра | Тип параметра | Описание параметра | Пример |
| uid | guid | Уникальный идентификатор детали/з/ч. Значение берётся из предыдущего вызова метода SaveOrder в случае, если нужно обновить значения трекинга. | |
| CreateDate | datetime | Дата создания (будет заменена на текущую) | |
| PartNumber | string (100) | ПартНомер | |
| PartName | string (255) | Наименование детали | |
| Price | decimal | Цена отгрузки | |
| Qnt | int | Количество | |
| Compensate | decimal | Размер компенсации для ASC | |
| ASCOrderNo | string (100) | № заказа ACЦ (ссылка на заказ) | |
| SPOrderNo | string (100) | № заявки з/ч (проверка при создании акта НРП) | |
| OrderCreate | datetime | Дата заказа запчасти | |
| PrognoseDate | datetime | Ожидаемая дата получения з/ч | |
| OrderUid | guid | Уникальный идентификатор трекинга. Значение берётся из предыдущего вызова метода SaveOrder. | |
| AscItemKey | string (50) | Внутренний ID детали АСЦ | |
| TypeOrder | guid | Тип заказчика, в основном пустой или АСЦ | 9314B01D-3D61-426C-BCAF-BFDEF25AAA56 |
| InvoiceNum | string (50) | Номер накладной | |
| InvoiceDate | datetime | Дата накладной | |
| InvoiceRef | guid | Ссылка на позицию в накладной. Не используется в данное время | |
| AscStore | int | =1, если деталь получена АСЦ не у провайдера, а со стороны =0, если получена АСЦ у провайдера. Возможность указывать детали своего склада зависит от настроек авторизации по бренду. | |
| Section | string (3) | Код секции. Значение берётся из GetCategIrisSectionCodes. | |
| Condition | string (3) | Код условия. Значение берётся из GetCategIrisConditionCodes. | |
| Symptom | string (3) | Код симптома. Значение берётся из GetCategIrisSymptomCodes. | |
| Defect | string (3) | Код дефекта. Значение берётся из GetCategIrisDefectCodes. | |
| Repair | string (3) | Код ремонта. Значение берётся из GetCategIrisRepairCodes. | |
| LocationCode | string (50) | Позиционный номер | |
| EditDate | datetime | Дата редактирования (будет заменена на текущую) | |
| EditUser | guid | Идентификатор пользователя | |
| ProblemPartSerial | string (255) | Серийный номер неисправной детали | |
| SetupPartSerial | string (255) | Серийный номер установленной детали |
Секция Payment
| Название параметра | Тип параметра | Описание параметра | Пример |
| uid | guid | Идентификатор заказа | 00000000-0000-0000-0000-000000000000 |
| Labor | decimal | Стоимость работы | |
| BonusASC | decimal | Бонус АСЦ | |
| Handling | decimal | Фиксированный тариф провайдера | |
| BonusCSP | decimal | Переменное вознаграждение провайдера | |
| BonusCSPPercent | decimal | Процент (% от тарифа) на момент формирования инвойса | |
| SU | decimal | Оплата доставки з/ч провайдера | |
| Transport | decimal | Оплата транспортировки/выезда | |
| SparePartsASC | decimal | Сумма компенсации з/ч АСЦ | |
| SparePartsCSP | decimal | Сумма компенсации з/ч провайдера | |
| AdditionalLabor | decimal | Оплата дополнительных работ АСЦ | |
| ASCSumm | decimal | Итого оплата АСЦ | |
| CSPSumm | decimal | Итого оплата провайдера | |
| TotalSumm | decimal | Итого сумма отплаты | |
| LaborCSP | decimal | Стоимость работы провайдера | |
| LaborPSU | decimal | Стоимость ремонта PSU | |
| LaborSSB | decimal | Стоимость ремонта SSB | |
| AdditionalLaborTotal | decimal | Всего стоимость дополнительных работ | |
| BonusASCPercent | decimal | Процент бонусов АСЦ | |
| SparePartsTotal | decimal | Всего стоимость з/ч | |
| AdditionalLaborDescr | String (1000) | Описание дополнительных работ |
Отдельный параметр
| Название параметра | Тип параметра | Описание параметра | Пример |
| RefUri | string | Ссылка на трекинг, которую можно открыть в браузере |
Секция ValidationErrors содержит коллекцию ErrorItem следующего вида:
| Название параметра | Тип параметра | Описание параметра | Пример |
| ErrorCode | string | Код ошибки | 43 |
| ErrorLevel | int | Уровень ошибки: 1-критичная, 3-предупреждение. | 1 |
| Status | string | Статус трекинга | |
| Descriptilon | string | Описание ошибки | Для продолжения ремонта необходимо ввести, по крайней мере, одну запасную часть |
Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
Входные параметры:
| Название параметра | Тип параметра | Обяз. | Описание параметра | Пример |
| ticket | string | Да | Сессионный ключ | YOB7IG8UG687068 |
Выходные параметры:
Возвращает коллекцию TrackingShortItem следующего вида:
| Название параметра | Тип параметра | Описание параметра | Пример |
| Uid | guid | Идентификатор ремонта | bf181853-8a82-4d7a-91b0-002e1105fe10 |
| NumKey | string (50) | Код ремонта в системе | ET0000001 |
| AscKey | string (50) | Код АСЦ ремонта | 11947 |
| Status | guid | Статус. Значения из GetSpStatuses | 574fa171-5482-4979-be0f-117a3dd0dd29 |
| LastEditDate | dateTime | Дата последнего редактирования ремонта | 2015-03-17T15:41:39.923 |
| MainBrandUid | guid | Идентификатор группы брендов. Значения из поля MainBrandUid из GetBrands | b457927a-766e-44b1-a79d-508adee3a915 |
| BrandUid | guid | Идентификатор бренда модели. Значения из поля BrandUid из GetBrands | 318c5448-3632-413e-ba36-16a95d85bb26 |
Список причин отмены трекинга
Возвращает справочник типов ремонтов по группе брендов (MainBrandUid).
Входные параметры:
| Название параметра | Тип параметра | Обяз? | Описание параметра | Пример |
| MainBrandUid | guid | Да | Ссылка на группу брендов, возвращаемую методом GetBrands | |
| ticket | string | Да | Сессионный ключ | srry8gJT2TJNZzckI6vGWwiRGZ6BcurM |
Выходные параметры:
Возвращает коллекцию RefItem следующего вида:
| Название параметра | Тип параметра | Описание параметра | Пример |
| Uid | guid | Идентификатор типа ремонта | b7a77d5a-e95a-11d9-b44e-000476de6b1e |
| Name | string (255) | Наименование типа ремонта | Гарантийный ремонт |
| Id | int | Id типа ремонта | |
| Description | string | Описание типа ремонта |
GetSpStatuses
Возвращает список статусов трекинга.
Входные параметры:
| Название параметра | Тип параметра | Обяз. | Описание параметра | Пример |
| ticket | string | Да | Сессионный ключ | srry8gJT2TJNZzckI6vGWwiRGZ6BcurM |
Возвращаемое значение:
Возвращает коллекцию StatusItem следующего вида:
| Название параметра | Тип параметра | Описание параметра | Пример |
| Uid | guid | Идентификатор статуса | 574fa171-5482-4979-be0f-117a3dd0dd29 |
| Name | string (255) | Наименование статуса | 23005 |
| Description | string (100) | Описание статуса | ОТЧЕТ |
| IsEnd | boolean | Является ли статус конечным | false |
GetTicket
Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
Входные параметры:
| Название параметра | Тип параметра | Обяз. | Описание параметра | Пример |
| Login | string | Да | Логин пользователя | Vasya |
| Password | string | Да | Пароль пользователя | 123456 |
Возвращаемое значение:
| Тип параметра | Описание параметра | Пример |
| string | Сессионный ключ | YOB7IG8UG687068 |
Возвращает справочник типов транспортировки по мету ремонта и бренду.
Возврат справочника зон транспортировки.
Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
SaveOrder
Создание/обновление трекинга.
Входные параметры:
| Название параметра | Тип параметра | Обяз? | Описание параметра | Пример |
| ticket | string | Да | Сессионный ключ | YOB7IG8UG687068 |
| record | TrackingRecord | Да | структура содержащая данные, идентична секции Tracking в методе GetOrderBySysKey |
Выходные параметры:
| Название параметра | Тип параметра | Описание параметра | Пример |
| 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 | Описание ошибки |
Порядок вызова методов и работы с сервисом
- Для начала работы требуется аутентифицироваться. Для этого нужно вызвать метод GetTicket с параметрами login и password и получить в ответ ticket. Он используются для вызова других методов сервиса. В качестве пользователя может использоваться любой созданный на сайте аккаунт с доступом к созданию трекинга.
- Далее нужно заполнить справочники (классификаторы) вашего сервиса, чтобы передавать их в метод сохранения ремонта. Справочники заполняются вызовами соответствующих методов класса «Получение классификатора».
- Ремонт создаётся методом SaveOrder. Любые изменения вносятся повторным вызовом этого метода. Метод возвращает в числе других параметров TrackingUid, необходим при сохранении вложений к трекингу SaveAttachment, получении информации по акту неремонтопригодности GetANRPInfo или акту технического освидетельствования GetATOInfo. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода.
- Важно:
- Ремонт в статусе «ОТЧЕТ», «ОТМЕНЁН», «ОПЛАЧЕН» не может быть обновлён.
- Ремонт в статусе «Ремонт начат» блокируется на изменение ряда полей:
- ReceiveDate - Дата приёма в ремонт
- Model - Модель
- SerialNumb - Серийный номер
- DesRepair - Заявленный дефект
- OrderNumBrand - Номер заявки ИЦ
- RepairTypeCurrent - Тип ремонта
То есть при передачи новых данных по этим полям, они будут проигнорированы.
Содержание
- Назначение API
- Список методов
- CreateTrackingCallCentr
- DeleteAttachment
- GetANRPInfo
- GetATOInfo
- GetActionPlace
- GetAttachment
- GetAttachmentKeys
- GetAttachmentTypes
- GetBrands
- GetCategIrisConditionCodes
- GetCategIrisDefectCodes
- GetCategIrisRepairCodes
- GetCategIrisSectionCodes
- GetCategIrisSymptomCodes
- GetIrisCodes
- GetModelCategories
- GetOrderByAscKey
- GetOrderBySysKey
- GetOrderKeys
- GetRejectReasons
- GetSpRepairTypes
- GetSpStatuses
- GetTicket
- GetTransportService
- GetTransportZone
- SaveAttachment
- SaveOrder
- Порядок вызова методов и работы с сервисом