Traffics

Трафик ИС ЭПД

Группа сообщений для работы с входящим и исходящим трафиком ИС ЭПД.

---

Командные модели

Данный блок содержит описание основных командных моделей, отвечающих за выполнение действий.

getTrafficCommandEvent

Команда для получения информации о трафике ИС ЭПД.

Примечание:

Временной интервал

Если разница между dateFrom и dateTo более месяца, то будет установлен временной интервал как [dateFrom; dateFrom + 1 месяц]

Если не заполнен dateTo, то будет установлен временной интервал как [dateFrom; dateFrom + 1 месяц]

Если не заполнен dateFrom, то будет установлен временной интервал как [dateTo - 1 месяц; dateTo]

Если не заполнены dateFrom и dateTo, то будет установлен временной интервал как [currentDate - 1 месяц; currentDate]

Лимиты

Если limit > 1e4, то limit будет установлен как 1e4 (10000).

Если limit <= 0, то limit будет установлен как 1e3 (1000).

Название	Обязательность	Тип	Описание
requestId	Да	uuid	ИД запроса
docflowType	Да	DocflowType	Тип документооборота
direction	Нет	int	Направление трафика (0 - входящий, 1 - исходящий). По умолчанию как (0 - входящий).
limit	Нет	int	Количество записей. Максимальное значение: 10000. По умолчанию 1000
abonentId	Нет	string (ИД ЭДО)	Идентификатора абонента с префиксом
system	Нет	string	Тип системы отправителя. Возможные варианты: 1chub, api, platforma
docType	Нет	DocType	Тип документа
dateFrom	Нет	date	Дата начала подсчета траффика (включительно). Если не указать, то будет предоставлена информация за последний месяц от даты полученного запроса.
dateTo	Нет	date	Дата окончания подсчета траффика (включительно). Разница между dateFrom не более 1го месяца. Если не указать, то отбор будет установлен на дату запроса
offsetId	Нет	int	Указывается значение offset_id. Является указанием, что выводить выборку таких данных, в которых offset_id меньше этого значения (пагинация).

Примеры валидных моделей:

Пример модели 0

{
  "requestId": "f3fdeb21-eb96-4b78-856e-4d99794cfe13",
  "abonentId": "2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723",
  "docflowType": "ETRN",
  "direction": 0,
  "system": "1chub",
  "dateFrom": "2022-01-13T21:01:00.493736Z",
  "dateTo": "2022-09-13T21:01:00.493736Z"
}

Пример модели 1

{
  "requestId": "f3fdeb21-eb96-4b78-856e-4d99794cfe13",
  "abonentId": "2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723",
  "docflowType": "ETRN",
  "direction": 0,
  "system": "1chub",
  "limit": 1000,
  "dateFrom": "2022-01-13T21:01:00.493736Z",
  "dateTo": "2022-09-13T21:01:00.493736Z"
}

---

Ответные модели

getTrafficOutboundEvent.

Ответное сообщение для события getTrafficCommandEvent.

Примечание:

Формат имени CSV файла с отчетом: traffic_<TrafficType>_<RequestID>_<CurrentDate.Format:YYYYMMDD>.csv

Где:

• TrafficType - incoming/outgoing,
• RequestID - идентификатор запроса getTrafficCommandEvent,
• CurrentDate.Format:YYYYMMDD - текущая дата в формате YYYYMMDD.

Формат CSV файла: doc_id,docflow_id,uid,doc_type,docflow_type,abonent_id,system,date

Где:

• doc_id - идентификатор документа
• docflow_id - идентификатор документооборота
• uid - УИД ГИС ЭПД
• doc_type - тип документа в формате DocType
• docflow_type - тип документооборота в формате DocFlowType
• abonent_id - идентификатор абонента (с префиксом оператора)
• system - тип системы откуда документ пришел/ушел
• date - дата создания записи в формате RFC3339

Название	Обязательность	Тип	Описание
requestId	Да	uuid	ИД запроса
storageId	Да	uuid	Содержит ссылку на файл .csv в ЕСХ. Время жизни файла 7 дней.
offsetId	Да	int	Уникальное значение для каждой выданной записи (используется для указания после какого элемента возвращать выборку данных)
userError	Нет	userError	Пользовательская ошибка

Пример модели

{
  "requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
  "storageId": "fd2d0466-cf48-4028-8531-eb90168885d3",
  "offsetId": 194
}

---