lb_tracking_api.DeviceApi

All URIs are relative to https://api.thelightbug.com/api

Method	HTTP request	Description
device_find_by_id	GET /devices/{id}	Find a model instance by {{id}} from the data source.
device_prototype_create_gateway_readings	POST /devices/{id}/gatewayReadings	Creates a new instance in gatewayReadings of this model.
device_prototype_create_messages	POST /devices/{id}/messages	Creates a new instance in messages of this model.
device_prototype_create_notification_triggers	POST /devices/{id}/notificationTriggers	Create alert/notification trigger for device
device_prototype_delete_gateway_readings	DELETE /devices/{id}/gatewayReadings	Deletes all gatewayReadings of this model.
device_prototype_delete_messages	DELETE /devices/{id}/messages	Deletes all messages of this model.
device_prototype_delete_notification_triggers	DELETE /devices/{id}/notificationTriggers	Remove all alert/notification trigger for device
device_prototype_destroy_by_id_gateway_readings	DELETE /devices/{id}/gatewayReadings/{fk}	Delete a related item by id for gatewayReadings.
device_prototype_destroy_by_id_notification_triggers	DELETE /devices/{id}/notificationTriggers/{fk}	Remove alert/notification trigger by id {fk} for device
device_prototype_destroy_by_id_points	DELETE /devices/{id}/points/{fk}	Delete a specific point for a device
device_prototype_destroy_by_id_transients	DELETE /devices/{id}/transients/{fk}	Delete a related item by id for transients.
device_prototype_find_by_id_gateway_readings	GET /devices/{id}/gatewayReadings/{fk}	Find a related item by id for gatewayReadings.
device_prototype_find_by_id_notification_triggers	GET /devices/{id}/notificationTriggers/{fk}	Find a related item by id for notificationTriggers.
device_prototype_find_by_id_points	GET /devices/{id}/points/{fk}	Retrieve a specific point for a device
device_prototype_find_by_id_readings	GET /devices/{id}/readings/{fk}	Retrieve a specific reading for a device
device_prototype_find_by_id_transients	GET /devices/{id}/transients/{fk}	Find a related item by id for transients.
device_prototype_flight_mode	GET /devices/{id}/flightMode
device_prototype_get_config	GET /devices/{id}/config	Retrieve configuration for a device
device_prototype_get_gateway_readings	GET /devices/{id}/gatewayReadings	Queries gatewayReadings of device.
device_prototype_get_messages	GET /devices/{id}/messages	Queries messages of device.
device_prototype_get_notification_triggers	GET /devices/{id}/notificationTriggers	Get alerts for device
device_prototype_get_points	GET /devices/{id}/points	Retrieve points for a device
device_prototype_get_readings	GET /devices/{id}/readings	Retrieve readings for a device
device_prototype_get_safe_zone	GET /devices/{id}/getSafeZone	Get safe-zone for device
device_prototype_get_transients	GET /devices/{id}/transients	Queries transients of device.
device_prototype_nearby_device_data	GET /devices/{id}/nearbyDeviceData
device_prototype_nearby_devices	GET /devices/{id}/nearbyDevices
device_prototype_set_safe_zone	POST /devices/{id}/setSafeZone	Update safe-zone for device
device_prototype_update_by_id_gateway_readings	PUT /devices/{id}/gatewayReadings/{fk}	Update a related item by id for gatewayReadings.
device_prototype_update_by_id_notification_triggers	PUT /devices/{id}/notificationTriggers/{fk}	Update an alert/notification trigger by id {fk} for device
device_prototype_update_by_id_transients	PUT /devices/{id}/transients/{fk}	Update a related item by id for transients.
device_prototype_update_config	PUT /devices/{id}/config	Update configuration for a device

device_find_by_id

Device device_find_by_id(id, filter=filter)

Find a model instance by {{id}} from the data source.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 'id_example' # str | Model id
filter = 'filter_example' # str | Filter defining fields and include - must be a JSON-encoded string ({\"something\":\"value\"}) (optional)

try:
    # Find a model instance by {{id}} from the data source.
    api_response = api_instance.device_find_by_id(id, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_find_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Model id
filter	str	Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})	[optional]

Return type

Device

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_create_gateway_readings

SensorReading device_prototype_create_gateway_readings(id, data=data)

Creates a new instance in gatewayReadings of this model.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
data = lb_tracking_api.SensorReading() # SensorReading | Body (JSON) (optional)

try:
    # Creates a new instance in gatewayReadings of this model.
    api_response = api_instance.device_prototype_create_gateway_readings(id, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_create_gateway_readings: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
data	SensorReading	Body (JSON)	[optional]

Return type

SensorReading

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_create_messages

DeviceMessage device_prototype_create_messages(id, data=data)

Creates a new instance in messages of this model.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
data = lb_tracking_api.DeviceMessage() # DeviceMessage | Body (JSON) (optional)

try:
    # Creates a new instance in messages of this model.
    api_response = api_instance.device_prototype_create_messages(id, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_create_messages: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
data	DeviceMessage	Body (JSON)	[optional]

Return type

DeviceMessage

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_create_notification_triggers

NotificationTrigger device_prototype_create_notification_triggers(id, data=data)

Create alert/notification trigger for device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
data = lb_tracking_api.NotificationTrigger() # NotificationTrigger | Body (JSON) (optional)

try:
    # Create alert/notification trigger for device
    api_response = api_instance.device_prototype_create_notification_triggers(id, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_create_notification_triggers: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
data	NotificationTrigger	Body (JSON)	[optional]

Return type

NotificationTrigger

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_delete_gateway_readings

device_prototype_delete_gateway_readings(id)

Deletes all gatewayReadings of this model.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id

try:
    # Deletes all gatewayReadings of this model.
    api_instance.device_prototype_delete_gateway_readings(id)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_delete_gateway_readings: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_delete_messages

device_prototype_delete_messages(id)

Deletes all messages of this model.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id

try:
    # Deletes all messages of this model.
    api_instance.device_prototype_delete_messages(id)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_delete_messages: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_delete_notification_triggers

device_prototype_delete_notification_triggers(id)

Remove all alert/notification trigger for device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id

try:
    # Remove all alert/notification trigger for device
    api_instance.device_prototype_delete_notification_triggers(id)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_delete_notification_triggers: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_destroy_by_id_gateway_readings

device_prototype_destroy_by_id_gateway_readings(id, fk)

Delete a related item by id for gatewayReadings.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for gatewayReadings

try:
    # Delete a related item by id for gatewayReadings.
    api_instance.device_prototype_destroy_by_id_gateway_readings(id, fk)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_destroy_by_id_gateway_readings: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for gatewayReadings

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_destroy_by_id_notification_triggers

device_prototype_destroy_by_id_notification_triggers(id, fk)

Remove alert/notification trigger by id {fk} for device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for notificationTriggers

try:
    # Remove alert/notification trigger by id {fk} for device
    api_instance.device_prototype_destroy_by_id_notification_triggers(id, fk)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_destroy_by_id_notification_triggers: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for notificationTriggers

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_destroy_by_id_points

device_prototype_destroy_by_id_points(id, fk)

Delete a specific point for a device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for points

try:
    # Delete a specific point for a device
    api_instance.device_prototype_destroy_by_id_points(id, fk)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_destroy_by_id_points: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for points

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_destroy_by_id_transients

device_prototype_destroy_by_id_transients(id, fk)

Delete a related item by id for transients.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for transients

try:
    # Delete a related item by id for transients.
    api_instance.device_prototype_destroy_by_id_transients(id, fk)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_destroy_by_id_transients: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for transients

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_find_by_id_gateway_readings

SensorReading device_prototype_find_by_id_gateway_readings(id, fk)

Find a related item by id for gatewayReadings.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for gatewayReadings

try:
    # Find a related item by id for gatewayReadings.
    api_response = api_instance.device_prototype_find_by_id_gateway_readings(id, fk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_find_by_id_gateway_readings: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for gatewayReadings

Return type

SensorReading

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_find_by_id_notification_triggers

NotificationTrigger device_prototype_find_by_id_notification_triggers(id, fk)

Find a related item by id for notificationTriggers.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for notificationTriggers

try:
    # Find a related item by id for notificationTriggers.
    api_response = api_instance.device_prototype_find_by_id_notification_triggers(id, fk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_find_by_id_notification_triggers: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for notificationTriggers

Return type

NotificationTrigger

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_find_by_id_points

Datapoint device_prototype_find_by_id_points(id, fk)

Retrieve a specific point for a device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for points

try:
    # Retrieve a specific point for a device
    api_response = api_instance.device_prototype_find_by_id_points(id, fk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_find_by_id_points: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for points

Return type

Datapoint

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_find_by_id_readings

SensorReading device_prototype_find_by_id_readings(id, fk)

Retrieve a specific reading for a device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for readings

try:
    # Retrieve a specific reading for a device
    api_response = api_instance.device_prototype_find_by_id_readings(id, fk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_find_by_id_readings: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for readings

Return type

SensorReading

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_find_by_id_transients

DeviceTransient device_prototype_find_by_id_transients(id, fk)

Find a related item by id for transients.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for transients

try:
    # Find a related item by id for transients.
    api_response = api_instance.device_prototype_find_by_id_transients(id, fk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_find_by_id_transients: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for transients

Return type

DeviceTransient

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_flight_mode

object device_prototype_flight_mode(id, duration)

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
duration = 8.14 # float | How long to go into flightMode, in minutes

try:
    api_response = api_instance.device_prototype_flight_mode(id, duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_flight_mode: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
duration	float	How long to go into flightMode, in minutes

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_get_config

DeviceConfig device_prototype_get_config(id, refresh=refresh)

Retrieve configuration for a device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
refresh = true # bool | unused (optional)

try:
    # Retrieve configuration for a device
    api_response = api_instance.device_prototype_get_config(id, refresh=refresh)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_get_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
refresh	bool	unused	[optional]

Return type

DeviceConfig

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_get_gateway_readings

list[SensorReading] device_prototype_get_gateway_readings(id, filter=filter)

Queries gatewayReadings of device.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
filter = 'filter_example' # str | JSON Filter object (optional)

try:
    # Queries gatewayReadings of device.
    api_response = api_instance.device_prototype_get_gateway_readings(id, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_get_gateway_readings: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
filter	str	JSON Filter object	[optional]

Return type

list[SensorReading]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_get_messages

list[DeviceMessage] device_prototype_get_messages(id, filter=filter)

Queries messages of device.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
filter = 'filter_example' # str | JSON Filter object (optional)

try:
    # Queries messages of device.
    api_response = api_instance.device_prototype_get_messages(id, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_get_messages: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
filter	str	JSON Filter object	[optional]

Return type

list[DeviceMessage]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_get_notification_triggers

list[NotificationTrigger] device_prototype_get_notification_triggers(id, filter=filter)

Get alerts for device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
filter = 'filter_example' # str | JSON Filter object (optional)

try:
    # Get alerts for device
    api_response = api_instance.device_prototype_get_notification_triggers(id, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_get_notification_triggers: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
filter	str	JSON Filter object	[optional]

Return type

list[NotificationTrigger]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_get_points

list[Datapoint] device_prototype_get_points(id, filter=filter)

Retrieve points for a device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
filter = 'filter_example' # str | JSON Filter object (optional)

try:
    # Retrieve points for a device
    api_response = api_instance.device_prototype_get_points(id, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_get_points: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
filter	str	JSON Filter object	[optional]

Return type

list[Datapoint]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_get_readings

list[SensorReading] device_prototype_get_readings(id, filter=filter)

Retrieve readings for a device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
filter = 'filter_example' # str | JSON Filter object (optional)

try:
    # Retrieve readings for a device
    api_response = api_instance.device_prototype_get_readings(id, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_get_readings: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
filter	str	JSON Filter object	[optional]

Return type

list[SensorReading]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_get_safe_zone

Geofence device_prototype_get_safe_zone(id)

Get safe-zone for device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id

try:
    # Get safe-zone for device
    api_response = api_instance.device_prototype_get_safe_zone(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_get_safe_zone: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id

Return type

Geofence

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_get_transients

list[DeviceTransient] device_prototype_get_transients(id, filter=filter)

Queries transients of device.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
filter = 'filter_example' # str | JSON Filter object (optional)

try:
    # Queries transients of device.
    api_response = api_instance.device_prototype_get_transients(id, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_get_transients: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
filter	str	JSON Filter object	[optional]

Return type

list[DeviceTransient]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_nearby_device_data

object device_prototype_nearby_device_data(id, nearby_id, date_range)

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
nearby_id = 'nearby_id_example' # str | 
date_range = 'date_range_example' # str | 

try:
    api_response = api_instance.device_prototype_nearby_device_data(id, nearby_id, date_range)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_nearby_device_data: %s\n" % e)

Parameters

Name	Type	Description
id	float	device id
nearby_id	str
date_range	str

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_nearby_devices

list[object] device_prototype_nearby_devices(id, date_range=date_range, correlation_id=correlation_id)

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
date_range = 'date_range_example' # str |  (optional)
correlation_id = 'correlation_id_example' # str |  (optional)

try:
    api_response = api_instance.device_prototype_nearby_devices(id, date_range=date_range, correlation_id=correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_nearby_devices: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
date_range	str		[optional]
correlation_id	str		[optional]

Return type

list[object]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_set_safe_zone

Geofence device_prototype_set_safe_zone(id, data)

Update safe-zone for device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
data = [lb_tracking_api.GeoPoint()] # list[GeoPoint] | Array of {lat:x,lng:y} points denoting the vertices of the safe-zone

try:
    # Update safe-zone for device
    api_response = api_instance.device_prototype_set_safe_zone(id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_set_safe_zone: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
data	list[GeoPoint]	Array of {lat:x,lng:y} points denoting the vertices of the safe-zone

Return type

Geofence

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_update_by_id_gateway_readings

SensorReading device_prototype_update_by_id_gateway_readings(id, fk, data=data)

Update a related item by id for gatewayReadings.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for gatewayReadings
data = lb_tracking_api.SensorReading() # SensorReading | Body (JSON) (optional)

try:
    # Update a related item by id for gatewayReadings.
    api_response = api_instance.device_prototype_update_by_id_gateway_readings(id, fk, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_update_by_id_gateway_readings: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for gatewayReadings
data	SensorReading	Body (JSON)	[optional]

Return type

SensorReading

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_update_by_id_notification_triggers

NotificationTrigger device_prototype_update_by_id_notification_triggers(id, fk, data=data)

Update an alert/notification trigger by id {fk} for device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for notificationTriggers
data = lb_tracking_api.NotificationTrigger() # NotificationTrigger | Body (JSON) (optional)

try:
    # Update an alert/notification trigger by id {fk} for device
    api_response = api_instance.device_prototype_update_by_id_notification_triggers(id, fk, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_update_by_id_notification_triggers: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for notificationTriggers
data	NotificationTrigger	Body (JSON)	[optional]

Return type

NotificationTrigger

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_update_by_id_transients

DeviceTransient device_prototype_update_by_id_transients(id, fk, data=data)

Update a related item by id for transients.

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
fk = 8.14 # float | Foreign key for transients
data = lb_tracking_api.DeviceTransient() # DeviceTransient | Body (JSON) (optional)

try:
    # Update a related item by id for transients.
    api_response = api_instance.device_prototype_update_by_id_transients(id, fk, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_update_by_id_transients: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
fk	float	Foreign key for transients
data	DeviceTransient	Body (JSON)	[optional]

Return type

DeviceTransient

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

device_prototype_update_config

DeviceConfig device_prototype_update_config(id, data=data)

Update configuration for a device

Example

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

# create an instance of the API class
api_instance = lb_tracking_api.DeviceApi()
id = 8.14 # float | device id
data = lb_tracking_api.DeviceConfig() # DeviceConfig | Body (JSON) (optional)

try:
    # Update configuration for a device
    api_response = api_instance.device_prototype_update_config(id, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->device_prototype_update_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	float	device id
data	DeviceConfig	Body (JSON)	[optional]

Return type

DeviceConfig

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

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

Files

DeviceApi.md

Latest commit

History

DeviceApi.md

File metadata and controls

lb_tracking_api.DeviceApi

device_find_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_create_gateway_readings

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_create_messages

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_create_notification_triggers

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_delete_gateway_readings

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_delete_messages

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_delete_notification_triggers

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_destroy_by_id_gateway_readings

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_destroy_by_id_notification_triggers

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_destroy_by_id_points

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_destroy_by_id_transients

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_find_by_id_gateway_readings

Example

Parameters

Return type

Authorization

HTTP request headers

device_prototype_find_by_id_notification_triggers