От версии 1.1 >
отредактировано Григорий Лепёшкин
на 2023/12/21 11:44
К версии < 5.1 >
отредактировано Григорий Лепёшкин
на 2023/12/21 14:56
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -2,13 +2,76 @@
2 2  (((
3 3  (% class="col-xs-12 col-sm-8" %)
4 4  (((
5 -= 1. Назначение API =
5 += Назначение API =
6 6  
7 7  Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения.
8 8  
9 -= 2. Список методов =
9 += Список методов =
10 10  
11 11  * [[CreateTrackingCallCentr>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=CreateTrackingCallCentr]] - Создание трекинга колл-центра.
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 +
12 12  * [[DeleteAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=DeleteAttachment]] -Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
13 13  * [[GetANRPInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetANRPInfo]] - Получение информации по акту неремонтопригодности.
14 14  * [[GetATOInfo>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=GetATOInfo]] - Получение информации по акту технического освидетельствования.
... ... @@ -36,11 +36,11 @@
36 36  * [[SaveAttachment>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveAttachment]] - Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
37 37  * [[SaveOrder>>url:http://cc.tpvrussia.ru:84/TrackingExchangeSoap.asmx?op=SaveOrder]] - Создание/обновление трекинга.
38 38  
39 -= 3. Порядок вызова методов и работы с сервисом =
102 += Порядок вызова методов и работы с сервисом =
40 40  
41 41  1. Для начала работы требуется аутентифицироваться. Для этого нужно вызвать метод [[GetTicket>>path:#_heading=h.1fob9te]] с параметрами login и password и получить в ответ ticket. Он используются для вызова других методов сервиса. В качестве пользователя может использоваться любой созданный на сайте аккаунт с доступом к созданию трекинга.
42 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]]. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода.
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]]. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода.
44 44  1. **Важно: **
45 45  
46 46  * Ремонт в статусе «ОТЧЕТ», «ОТМЕНЁН», «ОПЛАЧЕН»  не может быть обновлён.
... ... @@ -53,6 +53,8 @@
53 53  ** RepairTypeCurrent - Тип ремонта
54 54  
55 55  То есть при передачи новых данных по этим полям, они будут проигнорированы.
119 +
120 +
56 56  )))
57 57  
58 58  (% class="col-xs-12 col-sm-4" %)