/* Сервис помещений */ syntax = "proto3"; import "google/api/annotations.proto"; import "google/api/field_behavior.proto"; import "google/protobuf/timestamp.proto"; import "google/protobuf/wrappers.proto"; package keyapis.access_control.v1; option java_package = "ru.keyapis.access_control.v1"; option java_outer_classname = "KeyapisAccessControlV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_access_control_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.AccessControl.V1"; option objc_class_prefix = "KEYAPISACCESSCONTROLV1"; option php_namespace = "Keyapis\\AccessControl\\V1"; option ruby_package = "Keyapis::AccessControl::V1"; option optimize_for = LITE_RUNTIME; // Сервис управления доступом пользователей service AccessControlService { // Метод получения Квартиры. // Метод доступен для: admin, service, ltp_first, owner, employee rpc GetRoom(GetRoomRequest) returns (GetRoomResponse) { option (google.api.http) = { get: "/access_control/api/v1/room/{id}" }; } // Метод получения списка квартир. // Метод доступен для: admin, service, ltp_first, owner, employee, bti rpc GetRoomList(GetRoomListRequest) returns (stream GetRoomListResponse) { option (google.api.http) = { get: "/access_control/api/v1/room/list" }; } // Метод получения количества квартир. // Метод доступен для: admin, service, ltp_first, owner, employee, bti rpc GetRoomCount(GetRoomCountRequest) returns (GetRoomCountResponse) { option (google.api.http) = { get: "/access_control/api/v1/room/count" }; } // Метод установки режима подписок. // Метод доступен для: admin, service rpc PatchRoomSetSubscriptionMode (PatchRoomSetSubscriptionModeRequest) returns (PatchRoomSetSubscriptionModeResponse) { option (google.api.http) = { patch: "/access_control/api/v1/room/set_subscription_mode" body: "*" }; } // Метод проверки существования квартиры по ОРПОН и её номеру. // Возвращает true если найдена квартира с указанными параметрами. // Метод доступен для: admin, service rpc GetRoomOrponNumberExists(GetRoomOrponNumberExistsRequest) returns (GetRoomOrponNumberExistsResponse) { option (google.api.http) = { get: "/access_control/api/v1/room/orpon/{orpon}/number/{room_number}/exists" }; } } // Квартира message Room { // Идентификатор квартиры int32 id = 1 [(google.api.field_behavior) = REQUIRED]; // Номер string number = 2 [(google.api.field_behavior) = REQUIRED]; // Подъезд int32 entrance = 3 [(google.api.field_behavior) = REQUIRED]; // Этаж int32 floor = 4 [(google.api.field_behavior) = REQUIRED]; // Площадь float area = 5; // Идентификатор дома int32 building_id = 6 [(google.api.field_behavior) = REQUIRED]; // Идентификатор компании int32 company_id = 7 [(google.api.field_behavior) = REQUIRED]; // Номер абонента string abonent_id = 8 [(google.api.field_behavior) = REQUIRED]; // Тип enum Type { // Значение не указано TYPE_UNKNOWN = 0; // Этаж FLOOR = 1; // Подъезд ENTRANCE = 2; // Апартаменты APARTMENT = 3; // Вводно-распределительные устройства WATER_DISTRIBUTION = 4; // Индивидуальный тепловой пункт HEAT_POINT = 5; // Кладовая PANTRY = 6; // Колясочная WHEELCHAIR = 7; // Коммутационный шкаф WIRING_CLOSET = 8; // Консьержная CONCIERGE = 9; // КПП CHECKPOINT = 10; // Машиноместо PARKING_PLACE = 11; // Офис OFFICE = 12; // Подвал BASEMENT = 13; // Подстанция SUBSTATION = 14; // Помещение правления ТСЖ HOMEOWNERS_ROOM = 15; // Тамбур TAMBOUR = 16; // Узел ввода INPUT_NODE = 17; // Лобби LOBBY = 18; // Чердак ATTIC = 19; // Шахта лифта ELEVATOR_SHAFT = 20; // Электрощитовая SWITCHBOARD = 21; // Квартира по умолчанию DEFAULT_ROOM = 22; } // Тип Type type = 9 [(google.api.field_behavior) = REQUIRED]; // Дата создания. // # Тип: DateTime google.protobuf.Timestamp created_at = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата удаления. // # Тип: DateTime google.protobuf.Timestamp deleted_at = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; // Включен ли режим подписок bool is_subscription_mode_enabled = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Запрос получения квартиры message GetRoomRequest { // Идентификатор квартиры int32 id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос получения квартиры message GetRoomResponse { // Ошибка message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Квартира Room data = 1; // Ошибка Error error = 2; } } // Запрос на установку режима подписок message PatchRoomSetSubscriptionModeRequest { // Список идентификаторов МРФ repeated int32 mrf_ids = 1; // Список идентификаторов РФ repeated int32 rf_ids = 2; // Идентификатор ОРПОН дома int64 orpon_id = 3; // Список номеров квартир repeated string room_numbers = 4; // Справочник значений режимов подписки enum ModeType { // Значение не указано MODE_TYPE_UNKNOWN = 0; // Выключено DISABLED = 1; // Включено ENABLED = 2; } // Значение режима подписок ModeType mode_type = 5 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос на установку режима подписок message PatchRoomSetSubscriptionModeResponse { // Ошибка message Error { // Не передано значение ОРПОН: // - Если переданы номера квартир, то значение параметра ОРПОН обязательно message OrponExpected {} // Не передан хотя бы один идентификатор: // - Должен быть передан хотя бы один из параметров: // - mrf_ids; // - rf_ids; // - opron_id message IdExpected {} // Причина oneof reason { // Не передано значение ОРПОН OrponExpected orpon_expected = 1; // Не передан хотя бы один идентификатор IdExpected id_expected = 2; // Ошибка валидации ValidationError validation = 3; } } // Тип ответа oneof type { // Ошибка Error error = 1; } } // Запрос получения списка квартир message GetRoomListRequest { // Фильтр RoomFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Стандартный постраничный вывод RoomPaging paging = 2; } } // Ответ на запрос получения списка квартир message GetRoomListResponse { // Ошибка message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Квартира Room data = 1; // Ошибка Error error = 2; } } // Запрос получения количества квартир message GetRoomCountRequest { // Фильтр RoomFilter filter = 1; } // Ответ на запрос получения количества квартир message GetRoomCountResponse { // Тип результата oneof type { // Количество int32 data = 1; } } // Фильтр по квартирам message RoomFilter { // По идентификаторам домов repeated int32 building_ids = 1; // По подъездам repeated int32 entrances = 2; // По этажам repeated int32 floors = 3; // По идентификаторам компаний repeated int32 company_ids = 4; // По типам repeated Room.Type types = 5; // По идентификаторам устройств repeated int32 device_ids = 6; // По ОРПОНам repeated int64 orpons = 7; // По признаку служебной квартиры google.protobuf.BoolValue is_service_flag = 8; // По номерам квартир repeated string room_numbers = 9; } // Запрос проверки существования квартиры по ОРПОН и её номеру message GetRoomOrponNumberExistsRequest { // ОРПОН дома. // # Диапазон: 1..9223372036854775807 int64 orpon = 1 [(google.api.field_behavior) = REQUIRED]; // Номер квартиры. // # Диапазон: 1..4 string room_number = 2 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос проверки существования квартиры message GetRoomOrponNumberExistsResponse { // Ошибка message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Результат проверки: true - если квартира существует, false - в противном случае bool data = 1; // Ошибка Error error = 2; } } // Постраничный вывод message RoomPaging { // Справочник типов значений сортировки. // # Тип: byte enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По идентификатору ID = 1; // По времени создания CREATED_AT = 2; // По этажу и номеру FLOOR_THEN_NUMBER = 3; // По номеру NUMBER = 4; } // Тип значения сортировки. // Если значение не передано, то будет взято значение по умолчанию. // # По умолчанию: CREATED_AT OrderByType order_by_type = 1; // Справочник типов направлений сортировки. // # Тип: byte enum DirectionType { // Значение не указано DIRECTION_TYPE_UNKNOWN = 0; // От большего к меньшему DESC = 1; // От меньшего к большему ASC = 2; } // Тип направления сортировки. // # По умолчанию: DESC DirectionType direction_type = 2; // Количество записей на страницу. // Если значение 0 (не передано), то будет взято значение по умолчанию. // # Диапазон: 0..100. // # По умолчанию: 20 int32 limit = 3; // Сдвиг. // # Диапазон: 0..2147483647 int32 offset = 4; } // Ошибки валидации. // Эти проверки выполняются до обращения в базу данных message ValidationError { // Путь к полю в формате наименования прото string path = 1 [(google.api.field_behavior) = REQUIRED]; // Валидационное сообщение string message = 2 [(google.api.field_behavior) = REQUIRED]; }