def set_permissions(self, userId, deviceId=0, groupId=0):
"""Path: /permissions
Can only be used by admins to set positions
Args:
Returns:
json: Permissions object
"""
path = self._urls['permissions']
if deviceId !=0:
data = {
"userId": userId,
"deviceId": deviceId,
}
else:
if groupId != 0:
data = {
"userId": userId,
"groupId": groupId,
}
req = self._session.post(url=path, json=data)
if req.status_code == 204:
return data
if req.status_code == 400:
raise BadRequestException(message=req.text)
else:
raise TraccarApiException(info=req.text)
def login_with_token(self, token):
"""Path: /session
Creates a new session by using the provided token.
Args:
token: User session token.
This token can be generated on the web interface.
Returns:
json: Session info
Raises:
InvalidTokenException:
TraccarApiException:
"""
path = self._urls['session']
data = {'token': token}
req = self._session.get(url=path, params=data)
if req.status_code == 200:
self._token = token # Save valid token.
return req.json()
elif req.status_code == 404:
raise InvalidTokenException
else:
raise TraccarApiException(info=req.text)
def get_trips(self, startTime, endTime, deviceid=None, groupId=None):
"""Path: /trips
Can only be used by users to fetch events
Args:
Returns:
json: list of Report Trips
"""
path = self._urls['reports_trips']
data = {
'from': startTime,
'to': endTime,
'groupId': groupId,
}
if not groupId:
data['groupId'] = "1"
req = self._session.get(url=path, params=data)
if req.status_code == 200:
return req.json()
if req.status_code == 400:
raise UserPermissionException
else:
raise TraccarApiException(info=req.text)
def login_with_credentials(self, username, password):
"""Path: /session
Creates a new session with user's credentials.
Args:
username: User email
password: User password
Returns:
json: Session info
Raises:
ForbiddenAccessException: Wrong username or password.
TraccarApiException:
"""
path = self._urls['session']
data = {'email': username, 'password': password}
req = self._session.post(url=path, data=data)
if req.status_code == 200:
return req.json()
elif req.status_code == 401:
raise ForbiddenAccessException
else:
raise TraccarApiException(info=req.text)
def update_geofence(self, geofence_id, name=None, area=None, description=None,
calendarId=None, attributes=None):
# Get current geofence values
req = self.get_geofences(query='id', params=geofence_id)
geofence_info = req[0]
update = {
'name': name,
'area': area,
'description': description,
'calendarId': calendarId,
'attributes': attributes,
}
# Replaces all updated values in geofence_info
data = {key: value if update.get(key) is None else update[key] for key, value in geofence_info.items()}
headers = {'Content-Type': 'application/json'}
req = self._session.put('{}/{}'.format(self._urls['geofences'], geofence_id),
data=json.dumps(data), headers=headers)
if req.status_code == 200:
return req.json()
elif req.status_code == 400:
raise BadRequestException(message=req.text)
else:
raise TraccarApiException(info=req.text)
def get_geofences(self, query=None, params=None):
"""
Path: /geofences
Fetch a list of devices.
Without any params, returns a list of the user's devices.
Args:
query: Fetch by: userId, deviceId, groupId, id (Default value = None)
params: identifier or identifiers list.
Examples: [5, 10], 'geoFenceId' (Default value = None)
Returns:
json: Geofence list
Raises:
ObjectNotFoundException:
"""
path = self._urls['geofences']
if not query:
req = self._session.get(url=path)
else:
data = {query: params}
req = self._session.get(url=path, params=data)
if req.status_code == 200:
return req.json()
elif req.status_code == 400:
raise ObjectNotFoundException(obj=params, obj_type='Geofence')
else:
raise TraccarApiException(info=req.text)
def update_device(self, device_id, name=None, unique_id=None, group_id=None,
phone=None, model=None, contact=None, category=None):
# Get current device values
req = self.get_devices(query='id', params=device_id)
device_info = req[0]
update = {
'name': name,
'uniqueId': unique_id,
'phone': phone,
'model': model,
'contact': contact,
'category': category,
'groupId': group_id,
}
# Replaces all updated values in device_info
data = {key: value if update.get(key) is None else update[key] for key, value in device_info.items()}
headers = {'Content-Type': 'application/json'}
req = self._session.put('{}/{}'.format(self._urls['devices'], device_id),
data=json.dumps(data), headers=headers)
if req.status_code == 200:
return req.json()
elif req.status_code == 400:
raise BadRequestException(message=req.text)
else:
raise TraccarApiException(info=req.text)
def create_device(self, name, unique_id, group_id=0,
phone='', model='', contact='', category=None):
"""Path: /devices
Create a device. Only requires name and unique ID.
Other params are optional.
https://www.traccar.org/api-reference/#/definitions/Device
Args:
name: Device name.
unique_id: Device unique identifier.
group_id: Group identifier (Default value = 0)
phone: Phone number (Default value = None)
model: Device model (Default value = None)
contact: (Default value = None)
category: Device type (Optional)
Arrow, Default, Animal, Bicycle, Boat, Bus, Car, Crane,
Helicopter, Motorcycle, Offroad, Person, Pickup, Plane,
Ship, Tractor, Train, Tram, Trolleybus, Truck, Van
Returns:
json: Created device.
Raises:
BadRequestException: If device exists in database.
"""
path = self._urls['devices']
data = {
"id": -1, # id auto-assignment
"name": name,
"uniqueId": unique_id,
"phone": phone,
"model": model,
"contact": contact,
"category": category,
"groupId": group_id,
}
req = self._session.post(url=path, json=data)
if req.status_code == 200:
return req.json()
elif req.status_code == 400:
raise BadRequestException(message=req.text)
else:
raise TraccarApiException(info=req.text)
def get_all_users(self):
"""Path: /users
Can only be used by admins or managers to fetch all entities.
Args:
Returns:
json: All users
"""
path = self._urls['users']
data = {'all': True}
req = self._session.get(url=path, params=data)
if req.status_code == 200:
return req.json()
if req.status_code == 400:
raise UserPermissionException
else:
raise TraccarApiException(info=req.text)
def create_user(self, name, email, administrator=False, token=None):
"""Path: /users
Create a users. Only requires name, email.
Other params are optional.
https://www.traccar.org/api-reference/#/definitions/User
Args:
name: users name.
email: Device unique identifier.
administrator: Group identifier (Default value = 0)
token: Phone number (Default value = None)
Returns:
json: Created user.
Raises:
BadRequestException: If user exists in database.
"""
path = self._urls['users']
data = {
"id": -1, # id auto-assignment
"name": name,
"email": email,
"administrator": administrator,
"token": token,
"attributes":{"speedUnit":"kmh"},
}
req = self._session.post(url=path, json=data)
if req.status_code == 200:
return req.json()
elif req.status_code == 400:
raise BadRequestException(message=req.text)
else:
raise TraccarApiException(info=req.text)
def create_geofence(self, name, area, description='', calendarId=None, attributes=None):
"""Path: /geofences
Create a geofence. Only requires name and unique ID.
Other params are optional.
https://www.traccar.org/api-reference/#/definitions/Geofence
Args:
name: Geofence name.
description: Description
area: The Geofence area in WKT representation
Returns:
json: Created geofence.
Raises:
BadRequestException: If Geofence exists in database.
"""
path = self._urls['geofences']
data = {
"id": -1, # id auto-assignment
"name": name,
"description": description,
"area": str(area),
}
req = self._session.post(url=path, json=data)
if req.status_code == 200:
return req.json()
elif req.status_code == 400:
raise BadRequestException(message=req.text)
else:
raise TraccarApiException(info=req.text)
def get_route(self, deviceid, startTime, endTime):
"""Path: /route
Can only be used by users to fetch route
Args:
Returns:
json: list of positions
"""
path = self._urls['reports_route']
data = {
'deviceId': deviceid,
'from': startTime,
'to': endTime,
}
req = self._session.get(url=path, params=data)
if req.status_code == 200:
return req.json()
if req.status_code == 400:
raise UserPermissionException
else:
raise TraccarApiException(info=req.text)
def get_groups(self, userId=None):
"""
Path: /groups
Fetch a list of groups.
Without any params, returns a list of the user's groups.
Args: userId
Returns:
json: list of Groups
"""
path = self._urls['groups']
data = {
'userId': userId,
}
req = self._session.get(url=path, params=data)
if req.status_code == 200:
return req.json()
if req.status_code == 400:
raise UserPermissionException
else:
raise TraccarApiException(info=req.text)
def get_positions(self, deviceId=None, startTime=None, endTime=None, position_id=None):
"""Path: /positions
Can only be used by users to fetch positions
Args:
Returns:
json: list of Positions
"""
path = self._urls['positions']
data = {
'deviceId': deviceId,
'from': startTime,
'to': endTime,
'id': position_id,
}
req = self._session.get(url=path, params=data)
if req.status_code == 200:
return req.json()
if req.status_code == 400:
raise UserPermissionException
else:
raise TraccarApiException(info=req.text)
def delete_geofence(self, geofence_id):
req = self._session.delete('{}/{}'.format(self._urls['geofences'], geofence_id))
if req.status_code != 204:
raise TraccarApiException(info=req.text)