/*
  Спецификация для получения данных o местонахождении камеры
*/
syntax = "proto3";

package keyapis.vc.v1;

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/timestamp.proto";
import "keyapis/vc/v1/keyapis_vc_camera_v1.proto";

option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Vc.V1";
option go_package = "/keyapis_vc_v1";
option java_multiple_files = false;
option java_outer_classname = "KeyapisVcV1Proto";
option java_package = "ru.keyapis.vc.v1";
option java_string_check_utf8 = true;
option objc_class_prefix = "KEYAPISVCV1";
option optimize_for = LITE_RUNTIME;
option php_namespace = "Keyapis\\Vc\\V1";
option ruby_package = "Keyapis::Vc::V1";

// Сервис получения данных o местонахождении камеры
service CameraLocationDataService {
  // Метод получения данных o местонахождении камеры.
  // Метод доступен для: ApiKey
  rpc GetCameraLocationData (GetCameraLocationDataRequest) returns (GetCameraLocationDataResponse) {
    option (google.api.http) = {get: "/vc/api/v1/camera_location_data/{uid}"};
  }
}

// Запрос на получение данных o местонахождении камеры
message GetCameraLocationDataRequest {
  // uid видеопотока камеры
  string uid = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос на получение данных o местонахождении камеры
message GetCameraLocationDataResponse {
  // Ошибка запроса
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип ответа
  oneof type {
    // Данные o местонахождении камеры
    CameraLocationData data = 1;
    // Ошибка
    Error error = 2;
  }
}


// Данные o местонахождении камеры
message CameraLocationData {
  // Справочник статусов устройства
  enum StatusType {
    // Значение не указано
    STATUS_TYPE_UNKNOWN = 0;
    // Не в сети
    OFFLINE = 1;
    // В сети
    ONLINE = 2;
  }
  // Тип устройства
  enum DeviceType {
    // Значение не указано
    DEVICE_TYPE_UNKNOWN = 0;
    // Домофон
    INTERCOM = 1;
    // Видеокамера
    VIDEOCAMERA = 2;
    // Шлагбаум
    BARRIER = 3;
    // Калитка
    GATE = 4;
    // СКУД
    ACCESS_CONTROL_PANEL = 5;
    // Наружняя видеокамера
    OUTDOOR_CAMERA = 6;
  }
  // Дом
  message Building {
    // Идентификатор дома
    int32 id = 1;
    // Идентификатор РФ
    int32 rf_id = 2 [(google.api.field_behavior) = REQUIRED];
    // Идентификатор МРФ
    int32 mrf_id = 3 [(google.api.field_behavior) = REQUIRED];
    // ОРПОН
    int64 orpon = 4 [(google.api.field_behavior) = REQUIRED];
    // Город
    string city = 5 [(google.api.field_behavior) = REQUIRED];
    // Улица
    string street = 6 [(google.api.field_behavior) = REQUIRED];
    // Номер дома
    string number = 7;
    // Корпус
    string part = 8;
    // Идентификатор компании
    int32 company_id = 9 [(google.api.field_behavior) = REQUIRED];
    // Префикс
    string prefix = 10;
    // Дата создания.
    // # Тип: DateTime
    google.protobuf.Timestamp created_at = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
    // Дата удаления.
    // # Тип: DateTime
    google.protobuf.Timestamp deleted_at = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
    // Идентификатор квартирограммы
    int32 flatgramm_id = 13 [(google.api.field_behavior) = REQUIRED];
    // ОРПОН города, в котором находится дом
    int64 city_orpon = 14;
    // Идентификатор в федеральной информационной адресной системе.
    // Тип: Guid
    string fias = 15;
    // Наименования района.
    // # Диапазон: 0..200
    string district = 16;
    // Уникальный номер адреса.
    // # Диапазон: 0..9999999999
    string unom = 17;
    // ОРПОН региона
    int64 region_orpon = 18;
  }
  // Компания
  message Company {
    // Идентификатор компании.
    // # Диапазон: 1..2147483647
    int32 id = 1;
    // Идентификатор компании в системе Видеокомфорт
    int64 vc_company_id = 2;
    // Наименование компании
    string name = 3;
    // ИНН
    string inn = 4;
    // КПП
    string kpp = 5;
    // ОГРН
    string ogrn = 6;
  }
  // Идентификатор видеопотока в системе Видеокомфорт.
  // Тип: Guid
  string uid = 1 [(google.api.field_behavior) = REQUIRED];
  // Тип устройства.
  // # Тип: byte
  DeviceType device_type = 2;
  // Модель устройства
  string model = 3;
  // Серийный номер устройства
  string serial_number = 4;
  // Версия аппаратного обеспечения
  string hw_version = 5;
  // Версия программного обеспечения
  string sw_version = 6;
  // MAC-адрес.
  // # Диапазон: 17..17.
  // # Паттерн: /^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/
  string mac = 7;
  // Наименование устройства.
  // # Диапазон: 3..256
  string title = 8;
  // Сетевой адрес.
  // # Диапазон: 0..250
  string host = 9;
  // Статус устройства
  StatusType status_type = 10;
  // Номер подъезда.
  // # Диапазон: 1..100
  repeated int32 entrance_numbers = 11;
  // Идентификатор квартирограммы.
  // # Диапазон: 1..2147483647
  int32 flatgramm_id = 12;
  // Компания владелец устройства
  Company company = 13;
  // Массив домов камеры
  repeated Building buildings = 14;
}