def streams(self):
""" :reference: https://data.sense-t.org.au/api-docs/#!/default/get_streams
:allowed_param: 'id,limit'
"""
return bind_api(
api=self,
path='/streams',
payload_type='stream',
allowed_param=['limit', 'id'],
query_only_param=[
'id',
'limit',
'skip',
'near',
'radius',
'resulttype',
'expand',
'recursive',
'groupids',
'organisationid',
'locationid',
'usermetadatafield',
'usermetadatavalues'
],
payload_list=True,
require_auth=True,
)
def get_observations(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/get_observations
:allowed_param: 'streamid', 'start', 'end', 'time', 'si', 'ei',
'bounds', 'media', 'limit', 'sort'
"""
return bind_api(
api=self,
path='/observations',
method='GET',
payload_type='json',
allowed_param=[
],
query_only_param=[
'streamid',
'start',
'end',
'time',
'si',
'ei',
'bounds',
'media',
'limit',
'sort',
],
require_auth=True,
)
def platforms(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/put_platforms_id
"""
return bind_api(
api=self,
path='/platforms',
payload_type='platform',
payload_list=True,
require_auth=True,
)
def get_user(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/get_users_userid
:allowed_param: 'userid'
"""
return bind_api(
api=self,
path='/users/{userid}',
payload_type='user',
allowed_param=['userid'],
require_auth=True,
)
def get_location(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/get_location_id
:allowed_param: 'id'
"""
return bind_api(
api=self,
path='/locations/{id}',
method='GET',
payload_type='location',
allowed_param=['id'],
require_auth=True,
)
def get_group(self):
""" :reference: https://sensor-cloud.io/api-docs/#!/default/get_group
:allowed_param: 'id', 'recursive'
"""
return bind_api(
api=self,
path='/groups/{id}',
method='GET',
payload_type='json',
allowed_param=['id', 'recursive'],
require_auth=True,
)
def destroy_observations(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/delete_observations
:allowed_param: 'streamid'
"""
return bind_api(
api=self,
path='/observations',
method='DELETE',
payload_type='json',
query_only_param=[
'streamid',
],
require_auth=True,
)
def destroy_group(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/delete_group
:allowed_param: 'id', 'cascade'
"""
return bind_api(
api=self,
path='/groups/{id}',
method='DELETE',
payload_type='group',
allowed_param=[
'id',
'cascade'
],
require_auth=True,
)
def streams(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/put_platforms_id
:allowed_param: 'limit'
"""
return bind_api(
api=self,
path='/streams',
payload_type='stream',
allowed_param=['limit'],
query_only_param=[
'limit',
],
payload_list=True,
require_auth=True,
)
def destroy_stream(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/delete_streams_id
:allowed_param: 'id', 'cascade'
"""
return bind_api(
api=self,
path='/streams/{id}',
method='DELETE',
payload_type='stream',
allowed_param=[
'id',
],
query_only_param=[
'cascade',
],
require_auth=True,
)
def create_observations(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/post_observations
:allowed_param: 'streamid', 'results'
"""
return bind_api(
api=self,
path='/observations',
method='POST',
payload_type='json',
action='create',
allowed_param=[
'streamid',
'results',
],
query_only_param=[
'streamid',
],
require_auth=True,
)
def create_group(self):
""" :reference:
https://sensor-cloud.io/api-docs/#!/default/put_groups_id
:allowed_param: 'id', 'name', 'organisationid', 'description', 'groupids'
"""
return bind_api(
api=self,
path='/groups/{id}',
method='PUT',
payload_type='json',
action='create',
allowed_param=[
'id',
'name',
'organisationid',
'description',
'groupids',
],
require_auth=True,
)
def create_location(self):
""" :reference:
https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/put_location_id
:allowed_param: 'id', 'description', 'organisationid', 'geoJson'
"""
return bind_api(
api=self,
path='/locations/{id}',
method='PUT',
payload_type='json',
action='create',
allowed_param=[
'id',
'organisationid',
'description',
'geoJson',
'groupids',
],
require_auth=True,
)
def update_platform(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/put_platforms_id
:allowed_param: 'id', 'name', 'organisationid', 'groupids', 'streamids', 'deployments',
"""
return bind_api(
api=self,
path='/platforms/{id}',
method='PUT',
payload_type='platform',
action='update',
allowed_param=[
'id',
'name',
'organisationid',
'groupids',
'streamids',
'deployments',
],
require_auth=True,
)
def create_stream(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/put_streams_id
:allowed_param: 'id', 'resulttype', 'organisationid', 'groupids', 'procedureid', 'samplePeriod',
'reportingPeriod', 'streamMetadata',
"""
return bind_api(
api=self,
path='/streams/{id}',
method='PUT',
payload_type='stream',
action='create',
allowed_param=[
'id',
'resulttype',
'organisationid',
'groupids',
'procedureid',
'samplePeriod',
'reportingPeriod',
'streamMetadata',
],
require_auth=True,
)
def create_stream(self):
""" :reference: https://data.sense-t.org.au/api/sensor/v2/api-docs/#!/default/put_streams_id
:allowed_param: 'id', 'resulttype', 'organisationid', 'groupids', 'procedureid', 'samplePeriod',
'reportingPeriod', 'streamMetadata',
"""
return bind_api(
api=self,
path='/streams/{id}',
method='PUT',
payload_type='stream',
action='create',
allowed_param=[
'id',
'resulttype',
'organisationid',
'groupids',
'procedureid',
'samplePeriod',
'reportingPeriod',
'streamMetadata',
],
require_auth=True,
)
def get_groups(self):
""" :reference: https://sensor-cloud.io/api-docs/#!/default/get_groups
:allowed_param: 'id', 'organisationid', 'groupids', 'limit', 'skip', 'expand', 'recursive'
"""
return bind_api(
api=self,
path='/groups',
method='GET',
payload_type='json',
allowed_param=[
],
query_only_param=[
'id',
'organisationid',
'groupids',
'limit',
'skip',
'expand',
'recursive',
'usermetadatafield',
'usermetadatavalues'
],
require_auth=True,
)
