BPAPI Methods

All unit tests

RunIdMethodParametersResult GET1Result GET2Result POST
1R
1Subscription/Receipt?registration_id=[WELL_KNOWN_REGISTRATION_ID]
1VerifyCredentials
1VerifyPassword?email=someone@somewhere.com&password=MyLittleSecret
2VerifyPassword?email=unittest&password=1234
1Subscription/VerifyRegistrationId?registration_id=[WELL_KNOWN_REGISTRATION_ID]
1ChangePassword?email=unittest&old_password=1234&new_password=12345
2ChangePassword?email=unittest&old_password=12345&new_password=1234
1ResetPassword?email_or_value_code=nobody@nowhere.com
2ResetPassword?email_or_value_code=nobody@nowhere.com&execute_id=null&app_version=someString
3ResetPassword?email_or_value_code=ab1234cd.com&execute_id="null"&app_version="someString
1Places?service=yr.no&search_criteria=Trondheim
2Places?service=yr.no&search_criteria=Å%20Meldal
1Translations/Version?client_id=Connome_Android_vTEST&language=nb-NO
2Translations/Version?client_id=Connome_iOS_vTEST&language=nb-NO
1Translations?client_id=Connome_Android_vTEST&language=nb-NO&keys=StatusTabHeading,ControlTabHeading,NotificationTabHeading,Notification,switch_state,temperature,humidity
2Translations?client_id=Connome_iOS_vTEST&language=nb-NO&keys=StatusTabHeading,ControlTabHeading,NotificationTabHeading,Notification,switch_state,temperature,humidity
1Gateway/Add?network_id=ICCID_89[ADD_UNIQUENESS]®istration_id=[ADD_UNIQUENESS]&gateway_type=Generic4Devices
1Gateway/At?time=2033-12-31%2023_COLON_59&script=Api(%22Device_SLASH_2_SLASH_TurnOn%22)
1Gateway/Property?id=6061&name=network_id
2Gateway/Property?id=6061&name=network_id&field=value
3Gateway/Property?id=6061&name=at__PERCENT_
4Gateway/Property?id=6061&name=at__PERCENT_&field=History
1Gateway/AddProperty?property_name=virtual_mode&value=1
2Gateway/AddProperty?id=6061&property_name=user_defined_name&value=Transformator42
1Gateway/AddPropertySimple?registration_id=ab1234cd&property_name=subscription_automatic_renewal_mode&value=0
2Gateway/AddPropertySimple?registration_id=ab1234cd&property_name=subscription_automatic_renewal_mode&value=1
1Gateway/Refresh
2Gateway/Refresh?id=6061
3Gateway/Refresh?id=6061&quick=true
1Gateway/ReplaceWith?old_registration_id=xx1234xx&new_registration_id=yy1234yy
1Gateway
2Gateway?id=6061
1Gateway/AddDealer?dealer=5120
2Gateway/AddDealer?gateway=6061&child=5120
1Customer/Add?email=somebody[ADD_UNIQUENESS]@somewhere.com&password=MyLittleSecret
1Customer/AddAsChild?email=somebody[ADD_UNIQUENESS]@somewhere.com&password=MyLittleSecret
2Customer/AddAsChild?email=John%20Smith
1Customer/Property?id=5120&name=first_name
2Customer/Property?id=5120&name=first_name&field=value
3Customer/Property?id=5120&name=first_name,last_name
1Customer/Represent?id=5120
1Customer/AddProperty?property_name=first_name&value=John
2Customer/AddProperty?id=5120&property_name=first_name&value=John
1Customer/AddPropertySimple?registration_id=ab1234cd&property_name=first_name&value=unit
2Customer/AddPropertySimple?registration_id=ab1234cd&property_name=last_name&value=test
3Customer/AddPropertySimple?registration_id=ab1234cd&property_name=dealer_name&value=Your%20local%20electrician
1Customer/History
2Customer/History?id=5120
3Customer/History?id=5120&limit=42
1Customer?id=5120
2Customer?id=All
1Notification/AddEMail?email=somebody@somewhere.com
2Notification/AddEMail?email=somebody@somewhere.com&name=Mr.%20Somebody's%20main%20email%20address
1Notification/AddCellular?number=0047905343330
2Notification/AddCellular?number=0047905343330&name=Mr.%20Somebody's%20cellular%20phone
1Notification/AddApp?app_name=MinHytte_Android&id=ABC
2Notification/AddApp?app_name=AuraRemote_iOS&id=ABC
3Notification/AddApp?app_name=SikomLiving_iOS&id=ABC
1Notification/AddPowel?dms_id=42
2Notification/AddPowel?dms_id=42&name=AdditionalIdentificator
1Notify?text=Door%20left%20open
2Notify?text=temperature_notification_triggered
3Notify?text=Door%20left%20open&time_filter=20min
4Notify?text=Door%20left%20open&time_filter=2001-02-03 13_COLON_00
1Device/Add
1Device/Aggregation/History?id=55379&device_property=temperature&aggregation_type=Max&period=Day
1Device/Aggregation?id=55379&device_property=temperature
1Device/At?id=55379&time=2033-12-31%2023_COLON_59&script=TurnOn
1Device/Refresh?id=55379
2Device/Refresh?id=55379&quick=true
1Device/Temperature?id=55379
1Device/Simulate?id=55379&property_name=switch_state&value=1
1Device/Property?id=55379&name=switch_state
2Device/Property?id=55379&name=at__PERCENT_
3Device/Property?id=55379&name=power,temperature
4Device/Property?id=55379&name=at__PERCENT_&field=History
5Device/Property?id=55379&name=switch_state&field=value
6Device/Property?id=55379&name=power,temperature&field=value
7Device/Property?id=55379&name=switch_state&field=unit
8Device/Property?id=55379&name=switch_state&field=last_valid
9Device/Property?id=55379&name=switch_state&field=History
10Device/Property?id=55379&name=switch_state&field=PropertyId
11Device/Property?id=55379&name=switch_state&field=PropertyType
12Device/Property?id=55379&name=switch_state&field=DeviceProperty
13Device/Property?id=55379&name=switch_state&field=CustomerId
14Device/Property?id=55379&name=switch_state&field=GatewayId
15Device/Property?id=55379&name=switch_state&field=DeviceId
16Device/Property?id=55379&name=switch_state&field=Name
17Device/Property?id=55379&name=switch_state&field=Value
18Device/Property?id=55379&name=switch_state&field=Unit
19Device/Property?id=55379&name=switch_state&field=ValueWithUnit
20Device/Property?id=55379&name=switch_state&field=Created
21Device/Property?id=55379&name=switch_state&field=LastValid
22Device/Property?id=55379&name=switch_state&field=InvalidFrom
23Device/Property?id=55379&name=switch_state&field=Source
24Device/Property?id=55379&name=switch_state&field=Current
1Device/AddProperty?id=55379&property_name=user_defined_name&value=Kitchen lamp
2Device/AddProperty?id=Kitchen lamp&property_name=user_defined_group_name&value=Lamps
1Device/TurnOn?id=55379
1Device/TurnOff?id=55379
1Device?id=55379
2Device?id=All
3Device?id=All&gateway_id=6061
7Device?id=kitchen,55379
1Property/AddProperty?id=53630622&property_name=log&value=test
1Property/History?id=53630622
2Property/History?id=53630622&limit=10&no_filter=TRUE
3Property/History?id=53630622&limit=5min
4Property/History?id=53630622&limit=2001-02-03
5Property/History?id=53630622&limit=2001-02-03 13_COLON_00
6Property/History?id=53630622&limit=13_COLON_00
1Property/SetNoLongerCurrent?id=53630622
1Property?id=53630622
1AppView/AuxiliaryEquipment?app_version=v1&gateway_type=GSMECOComfort&language=nb-NO
1AppView?app_version=v2.2&gateway_id=All
2AppView?app_version=v2.2&gateway_id=6061

Documentation and tests automatically generated from source-code 2020-04-09 21:17



Automatically generated from BPAPI source-code 2020-04-09 21:17

Assembly built at 2020-04-03 13:42