Package: unicboard-billing-sdk
BILLING API DOCUMENTATIONUnicboard public api (in developing):base station apiget base station type api listmethod: GETroute: '/base-stations/types'request:"limit":int"offset":intresponse:["id":UUID"name":str"notes":str]get base station type api objectmethod: GETroute: '/base-stations/types/<base_station_type_id>'request:"base_station_type_id":UUIDresponse:"id":UUID"name":str"notes":strcreate base station type apimethod: POSTroute: '/base-stations/types'request:body:"name":str"notes":strresponse:"id":UUID"name":str"notes":strmodification base station type apimethod: PUTroute: '/base-stations/types/<base_station_type_id>'request:"base_station_type_id":UUIDbody:"name":str"notes":strresponse:"id":UUID"name":str"notes":strget base station api listmethod: GETroute: '/base-stations'request:"limit":int"offset":intresponse:["id":UUID"identifier":str"base_station_type":{"id":UUID"name":str"notes":str}]get base station api objectmethod: GETroute: '/base-stations/<base_station_id>'request:"base_station_id":UUIDresponse:"id":UUID"identifier":str"base_station_type":{"id":UUID"name":str"notes":str}create base station apimethod: POSTroute: '/base-stations'request:body:"base_station_type_id":UUID"identifier":strresponse:"id":UUID"identifier":str"base_station_type":{"id":UUID"name":str"notes":str}modification base station apimethod: PUTroute: '/base-stations/<base_station_id>'request:"base_station_id":UUIDbody:"base_station_type_id":UUID"identifier":strresponse:"id":UUID"identifier":str"base_station_type":{"id":UUID"name":str"notes":str}network apiget network api listmethod: GETroute: '/networks'request:"limit":int"offset":intresponse:["id":UUID"name":str"type_network":str"data_gateway_id":UUID4"sys_type":str"specifier":Optional[str]"params":Optional[Dict[str,Any]]]get network api objectmethod: GETroute: '/networks/<network_id>'request:"network_id":UUIDresponse:"id":UUID"name":str"type_network":str"data_gateway_id":UUID4"sys_type":str"specifier":Optional[str]"params":Optional[Dict[str,Any]]create network apimethod: POSTroute: '/networks'request:body:"name":str"type_network":str(input/output)"sys_type":str(INPUT_NBIOT/INPUT_LORA/OUTPUT_DATA_LOGGER_DEVICE_DATA/OUTPUT_DATA_AGGREGATOR_DEVICE_DATA)"specifier":Optional[str]response:"id":UUID"name":str"type_network":str"data_gateway_id":UUID4"sys_type":str"specifier":Optional[str]"params":Optional[Dict[str,Any]]modification network apimethod: PUTroute: '/networks/<network_id>'request:"network_id":UUIDbody:"name":str"type_network":str(input/output)"sys_type":str(INPUT_NBIOT/INPUT_LORA/OUTPUT_DATA_LOGGER_DEVICE_DATA/OUTPUT_DATA_AGGREGATOR_DEVICE_DATA)"specifier":Optional[str]response:"id":UUID"name":str"type_network":str"data_gateway_id":UUID4"sys_type":str"specifier":Optional[str]"params":Optional[Dict[str,Any]]device apiget device api listmethod: GETroute: '/devices'request:"limit":int"offset":intresponse:["manufacturer_serial_number":str"firmware_version":Optional[str]"hardware_version":Optional[str]"date_produced":Optional[datetime]"hacks":List[str]"device_tz":Optional[str]"device_clock_offset_s":Optional[int]"time_transition":str"device_manufacturer":{"id":UUID4,"name":str},"device_modification":{"id":UUID4,"name":Optional[str],"device_modification_type_id":Optional[UUID4],"device_modification_type":{"id":UUID4,"sys_name":str,"name_ru":str,"name_en":str,"type":str,"metering_type_id":UUID4,"device_metering_type":{"id":UUID4,"sys_name":str,"name_ru":str,"name_en":str}}}"device_channel":[{"device_id":UUID4"serial_number":int"last_date_event_no_data":Optional[datetime]"inactivity_limit":Optional[int]"device_meter":[{"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str}]}]"data_gateway_network_device":Optional[{"id":UUID4"uplink_protocol_id":UUID4"downlink_protocol_id":UUID4"data_gateway_network_id":UUID4"mac":int"key_id":Optional[UUID4]"device_id":UUID4"uplink_encryption_key":Optional[str]"downlink_encryption_key":Optional[str]"encryption_key":Optional[str]"protocol":{"id":UUID4"date_created":datetime"date_modified":datetime"name":str"type":ProtocolEnum}"network":Optional[{"id":UUID"name":str"type_network":str"data_gateway_id":UUID4"sys_type":str"specifier":Optional[str]"params":Optional[Dict[str,Any]]}]}]]get device api objectmethod: GETroute: '/devices/<device_id>'request:"device_id":UUIDresponse:"manufacturer_serial_number":str"firmware_version":Optional[str]"hardware_version":Optional[str]"date_produced":Optional[datetime]"hacks":List[str]"device_tz":Optional[str]"device_clock_offset_s":Optional[int]"time_transition":str"device_manufacturer":{"id":UUID4,"name":str},"device_modification":{"id":UUID4,"name":Optional[str],"device_modification_type_id":Optional[UUID4],"device_modification_type":{"id":UUID4,"sys_name":str,"name_ru":str,"name_en":str,"type":str,"metering_type_id":UUID4,"device_metering_type":{"id":UUID4,"sys_name":str,"name_ru":str,"name_en":str}}}"device_channel":[{"device_id":UUID4"serial_number":int"last_date_event_no_data":Optional[datetime]"inactivity_limit":Optional[int]"device_meter":[{"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str}]}]"data_gateway_network_device":Optional[{"id":UUID4"uplink_protocol_id":UUID4"downlink_protocol_id":UUID4"data_gateway_network_id":UUID4"mac":int"key_id":Optional[UUID4]"device_id":UUID4"uplink_encryption_key":Optional[str]"downlink_encryption_key":Optional[str]"encryption_key":Optional[str]"protocol":{"id":UUID4"date_created":datetime"date_modified":datetime"name":str"type":ProtocolEnum}"network":Optional[{"id":UUID"name":str"type_network":str"data_gateway_id":UUID4"sys_type":str"specifier":Optional[str]"params":Optional[Dict[str,Any]]}]}]crate device apimethod: POSTroute: '/devices/'request:body:"manufacturer_name":str"mac":int"manufacturer_serial_number":str"modification_type_id":UUID4"modification_id":UUID4"date_produced":Optional[datetime]"firmware_version":Optional[str]"hardware_version":Optional[str]"uplink_protocol_id":UUID4"downlink_protocol_id":UUID4"uplink_encryption_type":str(NO_ENCRYPTION/XTEA_V_NERO_V0/AES_ECB_V_NERO_V0/KUZNECHIK_V_NERO_V0)"downlink_encryption_type":str(NO_ENCRYPTION/XTEA_V_NERO_V0/AES_ECB_V_NERO_V0/KUZNECHIK_V_NERO_V0)"key_id":Optional[UUID4]"uplink_encryption_key":Optional[str]"downlink_encryption_key":Optional[str]"data_input_gateway_network_id":UUID4"data_gateway_id":UUID4"device_channels":List[{"serial_number":int"inactivity_limit":Optional[int]"device_meter":List[{"value_multiplier":float"unit_multiplier":float"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)}]}]"modification_name":Optional[str]"modification_type_name":Optional[str]response:"manufacturer_serial_number":str"firmware_version":Optional[str]"hardware_version":Optional[str]"date_produced":Optional[datetime]"device_manufacturer":{"id":UUID"name":str}"device_modification":{"id":UUID"name":Optional[str]"device_modification_type_id":Optional[UUID]"device_modification_type":{"id":UUID"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"metering_type_id":UUID"device_metering_type":{"id":UUID"sys_name":str"name_ru":str"name_en":str}}}"device_channel":[{"serial_number":int"inactivity_limit":Optional[int]"device_meter":[{"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str}]}]"data_gateway_network_device":Optional[{"id":UUID4"uplink_protocol_id":UUID4"downlink_protocol_id":UUID4"data_gateway_network_id":UUID4"mac":int"key_id":Optional[UUID4]"device_id":UUID4"uplink_encryption_key":Optional[str]"downlink_encryption_key":Optional[str]"encryption_key":Optional[str]"protocol":{"id":UUID4"date_created":datetime"date_modified":datetime"name":str"type":ProtocolEnum}"network":Optional[{"id":UUID"name":str"type_network":str"data_gateway_id":UUID4"sys_type":str"specifier":Optional[str]"params":Optional[Dict[str,Any]]}]}]modification device apimethod: PUTroute: '/devices/<device_id>'request:"device_id":UUIDbody:"device_modification_id":UUID"device_manufacturer_id":UUID"manufacturer_serial_number":str"date_produced":DateTime"firmware_version":str"hardware_version":str"device_tz":str"device_clock_offset_s":int"time_transition":str(summer/winter/unknown)response:"device_id":UUID"device_modification_id":UUID"device_manufacturer_id":UUID"manufacturer_serial_number":str"date_produced":DateTime"firmware_version":str"hardware_version":str"device_tz":str"device_clock_offset_s":int"time_transition":str(summer/winter/unknown)delete device apimethod: DELETEroute: '/devices/<device_id>'request:"device_id":UUIDresponse:200device network apiget device network api listmethod: GETroute: '/devices-networks/'request:"limit":int"offset":intresponse:["id":UUID4"uplink_protocol_id":UUID4"downlink_protocol_id":UUID4"data_gateway_network_id":UUID4"mac":int"key_id":Optional[UUID4]"device_id":UUID4"uplink_encryption_key":Optional[str]"downlink_encryption_key":Optional[str]"device":{"manufacturer_serial_number":str"firmware_version":Optional[str]"hardware_version":Optional[str]"date_produced":Optional[datetime]"device_manufacturer":{"id":UUID4"name":str}"device_modification":{"id":UUID4"name":Optional[str]"device_modification_type_id":Optional[UUID4]"device_modification_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"metering_type_id":UUID4"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}}}"device_channel":List[{"serial_number":int"inactivity_limit":Optional[int]"device_meter":[{"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str}]}]}"network":{"id":UUID"uplink_protocol_id":UUID"downlink_protocol_id":UUID"data_gateway_network_id":UUID"mac":int"key_id":Optional[UUID]"device_id":UUID"uplink_encryption_key":Optional[str]"downlink_encryption_key":Optional[str]"encryption_key":Optional[str]"protocol":{id:UUIDname:strtype:str(WATER5_V_NERO_V0/NCP_SMP_V0/SMP_V0)}"network":Optional["name":str"type_network":str(input/output)"data_gateway_id":UUID"data_gateway":{"name":str}"sys_type":str(INPUT_NBIOT/INPUT_LORA/OUTPUT_DATA_LOGGER_DEVICE_DATA/OUTPUT_DATA_AGGREGATOR_DEVICE_DATA)"specifier":Optional[str]"params":Optional[Dict[str,Any]]]}]get device network api objectmethod: GETroute: '/devices-networks/<device_network_id>'request:"device_network_id":UUIDresponse:"id":UUID4"uplink_protocol_id":UUID4"downlink_protocol_id":UUID4"data_gateway_network_id":UUID4"mac":int"key_id":Optional[UUID4]"device_id":UUID4"uplink_encryption_key":Optional[str]"downlink_encryption_key":Optional[str]"device":{"manufacturer_serial_number":str"firmware_version":Optional[str]"hardware_version":Optional[str]"date_produced":Optional[datetime]"device_manufacturer":{"id":UUID4"name":str}"device_modification":{"id":UUID4"name":Optional[str]"device_modification_type_id":Optional[UUID4]"device_modification_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"metering_type_id":UUID4"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}}}"device_channel":List[{"serial_number":int"inactivity_limit":Optional[int]"device_meter":[{"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str}]}]}"network":{"id":UUID"uplink_protocol_id":UUID"downlink_protocol_id":UUID"data_gateway_network_id":UUID"mac":int"key_id":Optional[UUID]"device_id":UUID"uplink_encryption_key":Optional[str]"downlink_encryption_key":Optional[str]"encryption_key":Optional[str]"protocol":{id:UUIDname:strtype:str(WATER5_V_NERO_V0/NCP_SMP_V0/SMP_V0)}"network":Optional["name":str"type_network":str(input/output)"data_gateway_id":UUID"data_gateway":{"name":str}"sys_type":str(INPUT_NBIOT/INPUT_LORA/OUTPUT_DATA_LOGGER_DEVICE_DATA/OUTPUT_DATA_AGGREGATOR_DEVICE_DATA)"specifier":Optional[str]"params":Optional[Dict[str,Any]]]}create device network apimethod: POSTroute: '/devices-networks'request:body:"mac":int"uplink_encryption_key":str"downlink_encryption_key":str"uplink_encryption_type":str"downlink_encryption_type":str"key_id":str"device_id":UUID"data_gateway_network_id":UUID"uplink_protocol_id":UUID"downlink_protocol_id":UUIDresponse:"id":UUID4"mac":int"uplink_encryption_key":str"downlink_encryption_key":str"uplink_encryption_type":str"downlink_encryption_type":str"key_id":str"device_id":UUID"data_gateway_network_id":UUID"uplink_protocol_id":UUID"downlink_protocol_id":UUIDmodification device network apimethod: PUTroute: '/devices-networks/<device_network_id>'request:"device_network_id":UUIDbody:"mac":int"uplink_encryption_key":str"downlink_encryption_key":str"uplink_encryption_type":str"downlink_encryption_type":str"key_id":str"device_id":UUID"data_gateway_network_id":UUID"uplink_protocol_id":UUID"downlink_protocol_id":UUIDresponse:"id":UUID4"mac":int"uplink_encryption_key":str"downlink_encryption_key":str"uplink_encryption_type":str"downlink_encryption_type":str"key_id":str"device_id":UUID"data_gateway_network_id":UUID"uplink_protocol_id":UUID"downlink_protocol_id":UUIDdelete device network apimethod: DELETEroute: '/devices-networks/<device_network_id>'request:"device_network_id":UUIDresponse: 200device channel apiget device channel api listmethod: GETroute: '/channels'request:"limit":int"offset":intresponse:["device_id":UUID4"serial_number":int"last_date_event_no_data":Optional[datetime]"inactivity_limit":Optional[int]"device_meter":["device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)]]get device channel api list by devicemethod: GETroute: '/devices/<device_id>/channels'request:"device_id":UUIDresponse:["device_id":UUID4"serial_number":int"last_date_event_no_data":Optional[datetime]"inactivity_limit":Optional[int]"device_meter":["device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)]]get device channel api objectmethod: GETroute: '/devices/<device_id>/channels/<device_channel_id>'request:"device_id":UUID"device_channel_id":UUIDresponse:"device_id":UUID4"serial_number":int"last_date_event_no_data":Optional[datetime]"inactivity_limit":Optional[int]"device_meter":["device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)]create device channel apimethod: POSTroute: '/devices/<device_id>/channels'request:"device_id":UUIDbody:"device_id":UUID"serial_number":int"inactivity_limit":Optional[int]response:"device_id":UUID4"serial_number":int"last_date_event_no_data":Optional[datetime]"inactivity_limit":Optional[int]"device_meter":["device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)]modification device channel apimethod: PUTroute: '/devices/<device_id>/channels/<device_channel_id>'request:"device_id":UUID"device_channel_id":UUIDbody:"device_id":UUID"serial_number":int"inactivity_limit":Optional[int]response:"device_id":UUID4"serial_number":int"last_date_event_no_data":Optional[datetime]"inactivity_limit":Optional[int]"device_meter":["device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)]delete device channel apimethod: DELETEroute: '/devices/<device_id>/channels/<device_channel_id>'request:"device_id":UUID"device_channel_id":UUIDresponse: 200device meter apiget device meter api listmethod: GETroute: '/meters'request:"limit":int"offset":intresponse:["id":UUID"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)]get device meter api list by channelmethod: GETroute: '/devices/<device_id>/channels/<device_channel_id>/meters'request:"device_id":UUID"device_channel_id":UUIDresponse:["id":UUID"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)]get device meter api objectmethod: GETroute: '/devices/<device_id>/channels/<device_channel_id>/meters/<meter_id>'request:"device_id":UUID"device_channel_id":UUID"meter_id":UUIDresponse:"id":UUID"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)create device meter apimethod: POSTroute: '/devices/<device_id>/channels/<device_channel_id>/meters'request:"device_id":UUID"device_channel_id":UUIDbody:"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)response:"id":UUID"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)modification device meter apimethod: PUTroute: '/devices/<device_id>/channels/<device_channel_id>/meters/<meter_id>'request:"device_id":UUID"device_channel_id":UUID"meter_id":UUIDbody:"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)response:"id":UUID"device_channel_id":UUID"value_multiplier":Optional[float]"unit_multiplier":Optional[float]"kind":str(COMMON_CONSUMED/COMMON_GENERATED/COMMON_ACTIVE_GENERATED/COMMON_ACTIVE_CONSUMED/COMMON_REACTIVE_GENERATED/COMMON_REACTIVE_CONSUMED/PHASE_A_ACTIVE_CONSUMED/PHASE_A_ACTIVE_GENERATED/PHASE_A_REACTIVE_CONSUMED/PHASE_A_REACTIVE_GENERATED/PHASE_B_ACTIVE_CONSUMED/PHASE_B_ACTIVE_GENERATED/PHASE_B_REACTIVE_CONSUMED/PHASE_B_REACTIVE_GENERATED/PHASE_C_ACTIVE_CONSUMED/PHASE_C_ACTIVE_GENERATED/PHASE_C_REACTIVE_CONSUMED/PHASE_C_REACTIVE_GENERATED)delete device meter apimethod: DELETEroute: '/devices/<device_id>/channels/<device_channel_id>/meters/<meter_id>'request:"device_id":UUID"device_channel_id":UUID"meter_id":UUIDresponse: 200device manufacturer apiget device manufacturer api listmethod: GETroute: '/manufacturers'request:"limit":int"offset":intresponse:["id":UUID"name":str]get device manufacturer api objectmethod: GETroute: '/manufacturers/<manufacturer_id>'request:"manufacturer_id":UUIDresponse:"id":UUID"name":strcreate device manufacturer api objectmethod: POSTroute: '/manufacturers'request:body:"name":strresponse:"id":UUID"name":strmodification device manufacturer api objectmethod: PUTroute: '/manufacturers/<manufacturer_id>'request:"manufacturer_id":UUIDbody:"name":strresponse:"id":UUID"name":strdelete device manufacturer api objectmethod: DELETEroute: '/manufacturers/<manufacturer_id>'request:"manufacturer_id":UUIDresponse: 200metering type apiget metering type api listmethod: GETroute: '/metering-types'request:"limit":int"offset":intresponse:["id":UUID"sys_name":str"name_ru":str"name_en":str]get metering type api objectmethod: GETroute: '/metering-types/<metering_type_id>'request:"metering_type_id":UUIDresponse:"id":UUID"sys_name":str"name_ru":str"name_en":strcreate metering type api objectmethod: POSTroute: '/metering-types'request:body:"sys_name":str"name_ru":str"name_en":strresponse:"id":UUID"sys_name":str"name_ru":str"name_en":strmodification metering type api objectmethod: PUTroute: '/metering-types/<metering_type_id>'request:"metering_type_id":UUIDbody:"sys_name":str"name_ru":str"name_en":strresponse:["id":UUID"sys_name":str"name_ru":str"name_en":str]delete metering type api objectmethod: DELETEroute: '/metering-types/<metering_type_id>'request:"metering_type_id":UUIDresponse: 200device modification type apiget device modification type api listmethod: GETroute: '/modification-types'request:"limit":int"offset":intresponse:["id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}]get device modification type api objectmethod: GETroute: '/modification-types/<modification_type_id>'request:"modification_type_id":UUIDresponse:"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}create device modification type apimethod: POSTroute: '/modification-types'request:body:"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":UUIDresponse:"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}modification device modification type apimethod: PUTroute: '/modification-types/<modification_type_id>'request:"modification_type_id":UUIDbody:"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":UUIDresponse:"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}delete device modification type apimethod: DELETEroute: '/modification-types/<modification_type_id>'request:"modification_type_id":UUIDresponse: 200device modification apiget device modification api listmethod: GETroute: '/modifications'request:"limit":int"offset":intresponse:["id":UUID4"name":str"max_daily_consumption":float"device_modification_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}}]get device modification api objectmethod: GETroute: '/modifications/<modification_id>'request:"modification_id":UUIDresponse:"id":UUID4"name":str"max_daily_consumption":float"device_modification_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}}create device modification apimethod: POSTroute: '/modifications'request:body:"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"metering_type_id":UUID4response:"id":UUID4"name":str"max_daily_consumption":float"device_modification_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}}modofication device modification apimethod: PUTroute: '/modifications/<modification_id>'request:"modification_id":UUIDbody:"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"metering_type_id":UUID4response:"id":UUID4"name":str"max_daily_consumption":float"device_modification_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str"type":str(smart_meter/modem)"device_metering_type":{"id":UUID4"sys_name":str"name_ru":str"name_en":str}}delete device modification apimethod: DELETEroute: '/modifications/<modification_id>'request:"modification_id":UUIDresponse: 200protocol apiget protocol api listmethod: GETroute: '/protocols'request:"limit":int"offset":intresponse:["id":UUID4"name":str"type":str(WATER5_V_NERO_V0/NCP_SMP_V0/SMP_V0/SMP_M_GAS_METER_V0/SMP_M_ENERGY_METER_V0/SMP_M_JUPITER_08B_V0/SMP_M_JUPITER_12B_V0/SMP_M_JUPITER_16B_V0/SMP_M_WATER_METER_04B_V0/SMP_M_WATER_METER_08B_V0/SMP_M_WATER_METER_12B_V0/SMP_M_WATER_METER_16B_V0/WATER5_V_JUPITER_FREESCALE_V0/WATER5_V_JUPITER_STM_V0/WATER5_V_FLUO_STM_V0/WATER5_V_FLUO_FREESCALE_V0/WATER5_V_FLUO_A_V0/WATER5_V_FLUO_S_V0/WATER5_V_GAS_V0/WATER5_V_JUPITER_LORA_V0/WATER5_V_FLUO_LORA_V0)]get protocol api objectmethod: GETroute: '/protocols/<protocol_id>'request:"protocol_id":UUIDresponse:"id":UUID4"name":str"type":str(WATER5_V_NERO_V0/NCP_SMP_V0/SMP_V0/SMP_M_GAS_METER_V0/SMP_M_ENERGY_METER_V0/SMP_M_JUPITER_08B_V0/SMP_M_JUPITER_12B_V0/SMP_M_JUPITER_16B_V0/SMP_M_WATER_METER_04B_V0/SMP_M_WATER_METER_08B_V0/SMP_M_WATER_METER_12B_V0/SMP_M_WATER_METER_16B_V0/WATER5_V_JUPITER_FREESCALE_V0/WATER5_V_JUPITER_STM_V0/WATER5_V_FLUO_STM_V0/WATER5_V_FLUO_FREESCALE_V0/WATER5_V_FLUO_A_V0/WATER5_V_FLUO_S_V0/WATER5_V_GAS_V0/WATER5_V_JUPITER_LORA_V0/WATER5_V_FLUO_LORA_V0)create protocol apimethod: POSTroute: '/protocols'request:body:"name":str"type":str(WATER5_V_NERO_V0/NCP_SMP_V0/SMP_V0/SMP_M_GAS_METER_V0/SMP_M_ENERGY_METER_V0/SMP_M_JUPITER_08B_V0/SMP_M_JUPITER_12B_V0/SMP_M_JUPITER_16B_V0/SMP_M_WATER_METER_04B_V0/SMP_M_WATER_METER_08B_V0/SMP_M_WATER_METER_12B_V0/SMP_M_WATER_METER_16B_V0/WATER5_V_JUPITER_FREESCALE_V0/WATER5_V_JUPITER_STM_V0/WATER5_V_FLUO_STM_V0/WATER5_V_FLUO_FREESCALE_V0/WATER5_V_FLUO_A_V0/WATER5_V_FLUO_S_V0/WATER5_V_GAS_V0/WATER5_V_JUPITER_LORA_V0/WATER5_V_FLUO_LORA_V0)response:"id":UUID4"name":str"type":str(WATER5_V_NERO_V0/NCP_SMP_V0/SMP_V0/SMP_M_GAS_METER_V0/SMP_M_ENERGY_METER_V0/SMP_M_JUPITER_08B_V0/SMP_M_JUPITER_12B_V0/SMP_M_JUPITER_16B_V0/SMP_M_WATER_METER_04B_V0/SMP_M_WATER_METER_08B_V0/SMP_M_WATER_METER_12B_V0/SMP_M_WATER_METER_16B_V0/WATER5_V_JUPITER_FREESCALE_V0/WATER5_V_JUPITER_STM_V0/WATER5_V_FLUO_STM_V0/WATER5_V_FLUO_FREESCALE_V0/WATER5_V_FLUO_A_V0/WATER5_V_FLUO_S_V0/WATER5_V_GAS_V0/WATER5_V_JUPITER_LORA_V0/WATER5_V_FLUO_LORA_V0)modification protocol apimethod: PUTroute: '/protocols/<protocol_id>'request:"protocol_id":UUIDbody:"name":str"type":str(WATER5_V_NERO_V0/NCP_SMP_V0/SMP_V0/SMP_M_GAS_METER_V0/SMP_M_ENERGY_METER_V0/SMP_M_JUPITER_08B_V0/SMP_M_JUPITER_12B_V0/SMP_M_JUPITER_16B_V0/SMP_M_WATER_METER_04B_V0/SMP_M_WATER_METER_08B_V0/SMP_M_WATER_METER_12B_V0/SMP_M_WATER_METER_16B_V0/WATER5_V_JUPITER_FREESCALE_V0/WATER5_V_JUPITER_STM_V0/WATER5_V_FLUO_STM_V0/WATER5_V_FLUO_FREESCALE_V0/WATER5_V_FLUO_A_V0/WATER5_V_FLUO_S_V0/WATER5_V_GAS_V0/WATER5_V_JUPITER_LORA_V0/WATER5_V_FLUO_LORA_V0)response:"id":UUID4"name":str"type":str(WATER5_V_NERO_V0/NCP_SMP_V0/SMP_V0/SMP_M_GAS_METER_V0/SMP_M_ENERGY_METER_V0/SMP_M_JUPITER_08B_V0/SMP_M_JUPITER_12B_V0/SMP_M_JUPITER_16B_V0/SMP_M_WATER_METER_04B_V0/SMP_M_WATER_METER_08B_V0/SMP_M_WATER_METER_12B_V0/SMP_M_WATER_METER_16B_V0/WATER5_V_JUPITER_FREESCALE_V0/WATER5_V_JUPITER_STM_V0/WATER5_V_FLUO_STM_V0/WATER5_V_FLUO_FREESCALE_V0/WATER5_V_FLUO_A_V0/WATER5_V_FLUO_S_V0/WATER5_V_GAS_V0/WATER5_V_JUPITER_LORA_V0/WATER5_V_FLUO_LORA_V0)delete protocol apimethod: DELETEroute: '/protocols/<protocol_id>'request:"protocol_id":UUIDresponse: 200base station task apiget base station task api listmethod: GETroute: '/bs-tasks'request:"limit":int"offset":intresponse:["id":UUID"effective_macs":List[int],"effective_datetime_from":datetime"effective_datetime_to":datetime"effective_count":int"reglament_type":str(schedule,on_capture,immediate)"every_s":int"reglament_exclusion_time_section":json"priority":int"regulation":str(immediate,lbt)"bs_id":UUID"status":str(created,in_progress,delivered,succeed,failed)"task_type":str(time_sync)"utc_offeset_s":int"protocol":str(6k7,unbp)"time":datetime]get base station task api list by base station idmethod: GETroute: '/bs-tasks/<bs_id>'request:"bs_id":UUID"limit":int"offset":intresponse:["id":UUID"effective_macs":List[int],"effective_datetime_from":datetime"effective_datetime_to":datetime"effective_count":int"reglament_type":str(schedule,on_capture,immediate)"every_s":int"reglament_exclusion_time_section":json"priority":int"regulation":str(immediate,lbt)"bs_id":UUID"status":str(created,in_progress,delivered,succeed,failed)"task_type":str(time_sync)"utc_offeset_s":int"protocol":str(6k7,unbp)"time":datetime]get base station task api objectmethod: GETroute: '/bs-tasks/<bs_task_id>'request:"bs_task_id":UUIDresponse:"id":UUID"effective_macs":List[int],"effective_datetime_from":datetime"effective_datetime_to":datetime"effective_count":int"reglament_type":str(schedule,on_capture,immediate)"every_s":int"reglament_exclusion_time_section":json"priority":int"regulation":str(immediate,lbt)"bs_id":UUID"status":str(created,in_progress,delivered,succeed,failed)"task_type":str(time_sync)"utc_offeset_s":int"protocol":str(6k7,unbp)"time":datetimecreate base station task api objectmethod: POSTroute: '/bs-tasks'request:body:"effective_macs":List[int],"effective_datetime_from":datetime"effective_datetime_to":datetime"effective_count":int"reglament_type":str(schedule,on_capture,immediate)"every_s":int"reglament_exclusion_time_section":json"priority":int"regulation":str(immediate,lbt)"bs_id":UUID"status":str(created,in_progress,delivered,succeed,failed)"task_type":str(time_sync)"utc_offeset_s":int"protocol":str(6k7,unbp)"time":datetimeresponse:"id":UUID"effective_macs":List[int],"effective_datetime_from":datetime"effective_datetime_to":datetime"effective_count":int"reglament_type":str(schedule,on_capture,immediate)"every_s":int"reglament_exclusion_time_section":json"priority":int"regulation":str(immediate,lbt)"bs_id":UUID"status":str(created,in_progress,delivered,succeed,failed)"task_type":str(time_sync)"utc_offeset_s":int"protocol":str(6k7,unbp)"time":datetimedelete base station task api objectmethod: DELETEroute: '/bs-tasks/<bs_task_id>'request:"bs_task_id":UUIDresponse: 200base station task log apiget base station task log api listmethod: GETroute: '/bs-tasks'request:"limit":int"offset":intresponse:["id":uuid4,pk"task":{"id":UUID"effective_macs":List[int],"effective_datetime_from":datetime"effective_datetime_to":datetime"effective_count":int"reglament_type":str(schedule,on_capture,immediate)"every_s":int"reglament_exclusion_time_section":json"priority":int"regulation":str(immediate,lbt)"bs_id":UUID"status":str(created,in_progress,delivered,succeed,failed)"task_type":str(time_sync)"utc_offeset_s":int"protocol":str(6k7,unbp)"time":datetime}"status":enum(created,in_progress,delivered,succeed,failed)]get base station task log api objectmethod: GETroute: '/bs-task-logs/<bs_taks_log_id>'request:"bs_taks_log_id":UUIDresponse:"id":uuid4,pk"task":{"id":UUID"effective_macs":List[int],"effective_datetime_from":datetime"effective_datetime_to":datetime"effective_count":int"reglament_type":str(schedule,on_capture,immediate)"every_s":int"reglament_exclusion_time_section":json"priority":int"regulation":str(immediate,lbt)"bs_id":UUID"status":str(created,in_progress,delivered,succeed,failed)"task_type":str(time_sync)"utc_offeset_s":int"protocol":str(6k7,unbp)"time":datetime}"status":enum(created,in_progress,delivered,succeed,failed)base station command apiget base station command api listmethod: GETroute: '/bs-commands'request:"limit":int"offset":intresponse:["id":UUID"status":str(created,in_progress,delivered,succeed,failed)"bs_id":UUID"command_type":str(delete_downlink_tasks,get_active_downlink_task_ids)"task_ids":List[int]]get base station command api objectmethod: GETroute: '/bs-commands/<bs_command_id>'request:"bs_command_id":UUIDresponse:"id":UUID"status":str(created,in_progress,delivered,succeed,failed)"bs_id":UUID"command_type":str(delete_downlink_tasks,get_active_downlink_task_ids)"task_ids":List[int]create base station command apimethod: POSTroute: '/bs-commands'request:body:"status":str(created,in_progress,delivered,succeed,failed)"bs_id":UUID"command_type":str(delete_downlink_tasks,get_active_downlink_task_ids)"task_ids":List[int]response:"id":UUID"status":str(created,in_progress,delivered,succeed,failed)"bs_id":UUID"command_type":str(delete_downlink_tasks,get_active_downlink_task_ids)"task_ids":List[int]delete base station command apimethod: DELETEroute: '/bs-commands/<bs_command_id>'request:"bs_command_id":UUIDresponse: 200base station command log apiget base station command log api listmethod: GETroute: '/bs-commands'request:"limit":int"offset":intresponse:["id":uuid4,pk"bs_command":{"id":UUID"status":str(created,in_progress,delivered,succeed,failed)"bs_id":UUID"command_type":str(delete_downlink_tasks,get_active_downlink_task_ids)"task_ids":List[int]}"status":enum(created,in_progress,delivered,succeed,failed)]get base station command log api objectmethod: GETroute: '/bs-command-logs/<bs_command_log_id>'request:"bs_command_log_id":UUIDresponse:"id":uuid4,pk"bs_command":{"id":UUID"status":str(created,in_progress,delivered,succeed,failed)"bs_id":UUID"command_type":str(delete_downlink_tasks,get_active_downlink_task_ids)"task_ids":List[int]}"status":enum(created,in_progress,delivered,succeed,failed)