Uids
УИДы
Группа сообщений для работы с УИДами ГИС ЭПД.
Командные модели
Данный блок содержит описание основных командных моделей, отвечающих за выполнение действий.
requestNewUidPoolCommandEvent
Команда для получения новых зарезервированных УИДов ГИС ЭПД для абонента.
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| abonentId | Да | string | ИД абонента |
| count | Нет | int | Количество УИДов ГИС ЭПД (максимальное количество - 200), если не указывать, то значение = 1 |
Пример модели
{
"requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
"abonentId": "2AEO9596552-364A-402E-AFFE-7C01F9C1B449",
"count": 1
}
requestCurrentUidPoolCommandEvent
Команда для получения полученных УИДов ГИС ЭПД по абоненту
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса(в нижнем регистре) |
| abonentId | Да | string | ИД абонента |
| limit | Нет | int | Количество УИДов ГИС ЭПД, если не указывать или значение = 0 - нет ограничений |
Пример модели
{
"requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
"abonentId": "2AEO9596552-364A-402E-AFFE-7C01F9C1B449",
"limit": 1
}
Ответные модели
Данный блок содержит описание основных ответных моделей от ядра системы.
uidPoolResponseOutboundEvent
Событие вовращает список УИДов ГИС ЭПД для абонента
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| abonentId | Да | string | ИД абонента |
| typeUid | Нет | TypeUid | Тип УИДа ГИС ЭПД |
| uids | Нет | uuid[array] | УИД ГИС ЭПД выданные ГИСом и зарезервированные за абонентом |
| message | Нет | string | Сообщение абоненту |
| userError | Нет | userError | Пользовательская ошибка |
Пример модели
{
"requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
"abonentId": "2AEO9596552-364A-402E-AFFE-7C01F9C1B449",
"typeUid": "NewUid",
"uids": [
"a8b53313-4603-4988-a91b-b313d262a6a6",
"a8b53313-4603-4988-a91b-b313d262a6a7",
"a8b53313-4603-4988-a91b-b313d262a6a8",
"a8b53313-4603-4988-a91b-b313d262a6a9"
],
"message": "Количество выдаваемых УИД 4 ограничено относительно запрошенных 20 с учетом выданных ранее и неиспользованных УИД"
}
uidCameOutboundEvent
Событие о приходе УИДа от ГИС ЭПД по конкретному ДО в сторону подписчика шины
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| docflowId | Да | uuid | ИД документооборота (в нижнем регистре) |
| receiverId | Да | string | ИД получателя |
| documentId | Да | uuid | ИД документа |
| uid | Да | uuid | УИД ГИС ЭПД |
| userError | Нет | userError | Пользовательская ошибка |
Пример модели
{
"docflowId": "a8b53313-4603-4988-a91b-b313d262a6a6",
"receiverId": "2AEК9596552-364A-402E-AFFE-7C01F9C1B420",
"documentId": "a8b53313-4603-4988-a91b-b313d262a6a7",
"uid": "a8b53313-4603-4988-a91b-b313d262a6a6"
}
Дополнительные модели
Данный блок содержит описание дополнительных моделей.
StatusType
Типы УИДов ГИС ЭПД
| Значение | Описание |
|---|---|
| NewUid | УИД ГИС ЭПД в ответ на команду получить новые УИДы |
| CurrentUid | УИД ГИС ЭПД в ответ на команду получить все использованные УИДы |
| Unknown | Тип неизвестен |