Skip to content

Latest commit

 

History

History
233 lines (166 loc) · 7.68 KB

AreasApi.md

File metadata and controls

233 lines (166 loc) · 7.68 KB
Raw

seventilation_client.AreasApi

All URIs are relative to https://api.sec-smart.app/v1

Method HTTP request Description
devices_id_areas_get GET /devices/{id}/areas Returns a device' areas object collection
devices_id_areas_label_put PUT /devices/{id}/areas/label Updates the name for the given area
devices_id_areas_mode_put PUT /devices/{id}/areas/mode Set a ventilation mode for a given area
devices_id_areas_timeprogram_put PUT /devices/{id}/areas/timeprogram Set a timed program for a given area

devices_id_areas_get

Areas devices_id_areas_get(id)

Returns a device' areas object collection

Returns the device subobject areas for the URL-encoded device ID.

Example

from __future__ import print_function
import time
import seventilation_client
from seventilation_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = seventilation_client.AreasApi(seventilation_client.ApiClient(configuration))
id = 'id_example' # str | 6-digit-long alphanumerical ID of the device to be adressed

try:
    # Returns a device' areas object collection
    api_response = api_instance.devices_id_areas_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AreasApi->devices_id_areas_get: %s\n" % e)

Parameters

Name Type Description Notes
id str 6-digit-long alphanumerical ID of the device to be adressed

Return type

Areas

Authorization

myTokenScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_areas_label_put

object devices_id_areas_label_put(body, id)

Updates the name for the given area

Updates the name for the given area.

Example

from __future__ import print_function
import time
import seventilation_client
from seventilation_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = seventilation_client.AreasApi(seventilation_client.ApiClient(configuration))
body = seventilation_client.AreasLabelBody() # AreasLabelBody | 
id = 'id_example' # str | 6-digit-long alphanumerical ID of the device to be adressed

try:
    # Updates the name for the given area
    api_response = api_instance.devices_id_areas_label_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AreasApi->devices_id_areas_label_put: %s\n" % e)

Parameters

Name Type Description Notes
body AreasLabelBody
id str 6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_areas_mode_put

object devices_id_areas_mode_put(body, id)

Set a ventilation mode for a given area

Sets the ventilation mode for the given area.

Example

from __future__ import print_function
import time
import seventilation_client
from seventilation_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = seventilation_client.AreasApi(seventilation_client.ApiClient(configuration))
body = seventilation_client.AreasModeBody() # AreasModeBody | 
id = 'id_example' # str | 6-digit-long alphanumerical ID of the device to be adressed

try:
    # Set a ventilation mode for a given area
    api_response = api_instance.devices_id_areas_mode_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AreasApi->devices_id_areas_mode_put: %s\n" % e)

Parameters

Name Type Description Notes
body AreasModeBody
id str 6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_areas_timeprogram_put

object devices_id_areas_timeprogram_put(body, id)

Set a timed program for a given area

Sets a timed program for the given area.

Example

from __future__ import print_function
import time
import seventilation_client
from seventilation_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = seventilation_client.AreasApi(seventilation_client.ApiClient(configuration))
body = seventilation_client.AreasTimeprogramBody() # AreasTimeprogramBody | 
id = 'id_example' # str | 6-digit-long alphanumerical ID of the device to be adressed

try:
    # Set a timed program for a given area
    api_response = api_instance.devices_id_areas_timeprogram_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AreasApi->devices_id_areas_timeprogram_put: %s\n" % e)

Parameters

Name Type Description Notes
body AreasTimeprogramBody
id str 6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]