Протокол¶

Оглавление¶

Cервис-адаптер вокруг Lego API экосистемы РТК

LegoAdapterService¶

Cервис-адаптер вокруг Lego API экосистемы РТК

Название метода	Описание	Тип запроса	Тип ответа
GetLegoAdapterServiceCheck	Метод проверки услуги. Возвращает true если хотя бы у одного аккаунта на квартире есть нужный сервис и он содержит активный компонент. Метод доступен для: admin, service	keyapis.ecosystem.v1.GetLegoAdapterServiceCheckRequest	keyapis.ecosystem.v1.GetLegoAdapterServiceCheckResponse

GetLegoAdapterServiceCheckRequest ¶

Запрос проверки услуги на квартире

Поле	Описание	Тип	Признак
orpon	ОРПОН. Идентификатор дома. # Диапазон: 0..9223372036854775807	int64	REQUIRED
room_number	Номер квартиры. # Паттерн: /^[0-9]{1,4}$/	string	REQUIRED
service_type	Тип услуги	keyapis.ecosystem.v1.Service.Type	REQUIRED

GetLegoAdapterServiceCheckResponse ¶

Результат запроса метода проверки услуги на квартире

Поле	Описание	Тип	Признак
data	Наличие активной услуги на квартире	optional bool
error	Ошибка	optional keyapis.ecosystem.v1.GetLegoAdapterServiceCheckResponse.Error

GetLegoAdapterServiceCheckResponse.Error ¶

Ошибка запроса метода проверки услуги на квартире

Поле	Описание	Тип	Признак
validation	Ошибка валидации запроса информации об услугах пользователя	optional keyapis.ecosystem.v1.ValidationError
ecosystem_api_error	Ошибка запроса к API экосистемы	optional keyapis.ecosystem.v1.GetLegoAdapterServiceCheckResponse.Error.EcosystemApiError

GetLegoAdapterServiceCheckResponse.Error.EcosystemApiError ¶

Ошибка запроса к API экосистемы

Service ¶

Услуга

ValidationError ¶

Ошибки валидации. Эти проверки выполняются до обращения в базу данных

Поле	Описание	Тип	Признак
path	Путь к полю в формате наименования прото	string	REQUIRED
message	Валидационное сообщение	string	REQUIRED

Service.Type ¶

Тип услуги

Номер	Тип	Название
0	TYPE_UNKNOWN	Значение не указано
1	SOTOVAYA_SVYAZ_MVNO	Cотовая связь
2	IPTV	Цифровое интерактивное ТВ
3	SHPD	Домашний интернет
4	KABELNOE_TV	Кабельное цифровое ТВ
5	FIKSIROVANNAYA_SVYAZ	Стационарный телефон
6	ROSTELECOM_LYCEUM	Лицей
7	SMART_HOUSE	Умный дом
8	JURIST	Юрист
9	WINK	WINK ТВ
10	SALE_EQUIPMENT	Оборудование
11	SMART_INTERCOM	Ключ
12	SMART_BARRIER	Шлагбаум
13	WARRANTY_PLUS	Гарантия плюс
14	ANALOG_CABLE_TV	Аналоговое цифровое ТВ
15	OTT_PERSON	АЛЛЁ
16	WIFI	Беспроводной интернет

Скалярные типы значений¶

.proto Type	Примечание	Python	Go	Ruby	C#	C++	Java	PHP
double		float	float64	Float	double	double	double	float
float		float	float32	Float	float	float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int	int32	Bignum or Fixnum (as required)	int	int32	int	integer
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int/long	int64	Bignum	long	int64	long	integer/string
uint32	Uses variable-length encoding.	int/long	uint32	Bignum or Fixnum (as required)	uint	uint32	int	integer
uint64	Uses variable-length encoding.	int/long	uint64	Bignum or Fixnum (as required)	ulong	uint64	long	integer/string
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int	int32	Bignum or Fixnum (as required)	int	int32	int	integer
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int/long	int64	Bignum	long	int64	long	integer/string
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	int	uint32	Bignum or Fixnum (as required)	uint	uint32	int	integer
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	int/long	uint64	Bignum	ulong	uint64	long	integer/string
sfixed32	Always four bytes.	int	int32	Bignum or Fixnum (as required)	int	int32	int	integer
sfixed64	Always eight bytes.	int/long	int64	Bignum	long	int64	long	integer/string
bool		boolean	bool	TrueClass/FalseClass	bool	bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	str/unicode	string	String (UTF-8)	string	string	String	string
bytes	May contain any arbitrary sequence of bytes.	str	[]byte	String (ASCII-8BIT)	ByteString	string	ByteString	string