• phone

• 201 - Not found in database

• from
• to
• title
• message

• payer - string. some payer description e.g. "John Doe"
• sum - int(restriction of database structure). bill sum in default currency e.g. 1005

• 222 - Plugin not found (when plugin 29 not available for user)

• limit - maximum number of bills to return (maximum and default 10 000) - optional
• offset - get bills starting from offset (default 0) - optional

errors:

• 222 - Plugin not found (when plugin 29 not available for user)

• 7 - Invalid parameters
• 204 - Entity not found - when the marker entry is not exists

errors:

• 7 - Invalid parameters
• 211 - Requested time span is too big (more than maxReportTimeSpan config option)
• 217 - The list contains non-existent entities - if one of the specified trackers does not exist, is blocked or doesn't have required tariff features
• 221 - Device limit exceeded (if device limit set for the user's dealer has been exceeded)

errors:

spreadsheet/parse

errors:

get_ui_config(...)

parameters:

• domain - (string) Dealer's monitoring interface domain, e.g. "itrack.live"

return:

• branding_web - allow to use custom logos, color theme, domain and favicon in UI for web version
• branding_mobile - allow to use custom icon, logo, color theme in the mobile applications
• subpaas - allow to use Sub-Dealers (can be used only together with itrack_label)
• itrack_label - show "Powered by iTrack" in UI (required for subpaas feature)

read(...)

session types:

parameters:

• external_id - an external id of task. Non-null, non-empty string.

return:

errors:

• 201 - Not found in database (when there is no task or checkpoint with specified conditions)

list(...)

session types:

parameters:

• external_id - an external id of task. Non-null, non-empty string.

return:

errors:

• 201 - Not found in database (when there is no task or checkpoint with specified conditions)

list(...)

return:

errors:

• General types only.

create(...)

parameters:

• department - an department object Non-null.

return:

errors:

• General types only.

update(...)

parameters:

• department - an department object Non-null.

return:

errors:

• 201 - Not found in database (if there is no department with such id)

delete(...)

parameters:

• department_id - Id of the department, int.

return:

errors:

• 201 - Not found in database (if there is no department with such id)

• journal

list(...)

return:

errors:

• General types only.

create(...)

parameters:

• employee - an employee object Non-null.

return:

errors:

• 247 - Entity already exists, if tracker_id!=null and exists employee that already binded to this tracker_id

read(...)

parameters:

• employee_id - Id of the employee, int.

return:

errors:

• 201 - Not found in database (if there is no employee with such id)

update(...)

parameters:

• employee - an employee object Non-null.

return:

errors:

• 201 - Not found in database (if there is no employee with such id)
• 247 - Entity already exists, if tracker_id!=null and exists employee that already binded to this tracker_id

delete(...)

parameters:

• employee_id - Id of the employee, int.

return:

errors:

• 201 - Not found in database (if there is no employee with such id)

send_email(...)

parameters:

• feedback
• type - optional

return:

stats/read

return:

• Form fields and values
• template

list(...)

return:

errors:

• General types only.

create(...)

parameters:

• garage - an garage object Non-null.

return:

errors:

• general types only

update(...)

parameters:

• garage - an garage object Non-null.

return:

errors:

• 201 - Not found in database (if there is no garage with such id)

delete(...)

parameters:

• name
• description
• type
• namegarage_id
• descriptionId of the garage to delete
• typeint

return:

errors:

• 201 - Not found in database (if there is no garage with such id)

• google
• yandex
• progorod
• osm
• locationiq

search_address(...)

parameters:

• q - address (or place) or coordinates (comma separated decimal degrees e.g. 60.0,-61.0) to geocode
• lang - language in which results should be. E.g. "en"
• geocoder - geocoder type
• bounds - optional, JSON object. The bounding box, specified by coordinates of northwest and southeast corners. Geocoder will preferably return results from within these bounds. That is the parameter influences the priority of results, so if more relevant results exist outside of bounds, they may be included.
• lang - optional, string, ISO 639 language code
• with_details - optional, boolean. If true then the response will contain details

return:

search_location(...)

parameters:

• location - not null, location (see: custom types section)
• geocoder - optional, string (enum). Now supported google, osm, yandex, locationiq geocoders.
• lang - optional, string, ISO 639 language code
• with_details - optional, boolean. If true then the response will contain details
• goal - optional, string (enum). Now supported ui, ui_user_action. Helps to choose the target geocoder. Use ui_user_action for requests initiated by user, otherwise ui.

Search address by location. User language wil be used If lang is omitted.

return:

• common_history_entry
{
   "id": ,
   "type": "common",
   "is_read": ,
   "message": ,
   "time": ,
   "event": // type of history event
}


• tracker_history_entry
{
   "id": ,
   "type": "tracker"
   "is_read": ,
   "message": ,
   "time": ,
   "event": , // type of history event
// extension
   "tracker_id": , // column object_id
   "rule_id": , // column event_id
   "track_id": ,
   "location":{
      "lat": ,
      "lng": ,
      "precision":
   },
   "address": "address", // string. address of location or "" (empty string)
   "extra": {
      "task_id": , //related task identifier
      "parent_task_id": , //related parent task identifier (for task checkpoint related history entries)
      "counter_id": , //related counter identifier
      "service_task_id": , //related service task id
      "checkin_id": , //related check-in marker
      "place_ids": , //related place identifiers,
      "last_known_location": , //true if location may be outdated,
      "tracker_label": ,//tracker label
      "emergency": ${boolean} //true for events with a same flag, optional
   }
}


• Depricated event types
  
  • camera_history_entry
    
    { "id": , "type": "camera" "is_read": , "message": , "time": , "event": , // type of history event // extension "camera_id": , "pack_id": // photos pack id }
  
  
  • socket_history_entry
    
    { "id": , "type": "camera" "is_read": , "message": , "time": , "event": , // type of history event // extension "socket_id": }

read(...)

parameters:

• id - int. history entry ID
• add_tracker_label - boolean. optional, if true tracker label will be added to message

return:

errors:

• 201 - Not found in database (when there are no history entries with that id)

mark_read(...)

parameters:

• id - int. history entry ID

return:

errors:

• 201 - Not found in database (when there are no history entries with that id)

mark_read_all()

return:

tracker/

list(...)

parameters:

• trackers - [int]. list of tracker's ids
• from - date/time. start date/time for searching
• to - date/time. end date/time for searching. must be after "from" date
• events - ["string"] (optional, default: all). list of history types
• limit - int (optional, default: maxHistoryLimit). max count of entries in result
• ascending - boolean (optional, default: true). Sort ascending by time when it is true and descending when false.

If events (event types) not passed then list all event types.

Available event types: alarmcontrol, battery_off, bracelet_close, bracelet_open, crash_alarm, detach, door_alarm, driver_changed, force_location_request, g_sensor, gps_lost, gps_recover, gsm_damp, harsh_driving, hood_alarm, idle_end, idle_start, ignition, info, input_change, inroute, outroute, inzone, outzone, lowpower, obd_plug_in, obd_unplug, obj_control, offline, online, parking, poweroff, poweron, security_control, sos, speedup, track_end, track_start, sensor_inrange, sensor_outrange, strap_bolt_cut, strap_bolt_ins, vibration_start, vibration_end, light_sensor_bright, light_sensor_dark

Default and max limit is 100 by default. (Note for StandAlone: this value configured by maxHistoryLimit config option).



example:

return:

errors:

• 211 - Requested time span is too big (time span between from and to is more than maxReportTimeSpan days)
• 212 - Requested limit is too big (limit is more than maxHistoryLimit)
• 217 - List contains nonexistent entities - if one of the specified trackers does not exist or is blocked

type/

list(...)

parameters:

• locale - locale code
• only_tracker_events - boolean (optional). Default - true.

return:

unread/

list(...)

parameters:

• limit, int, optional
• from, date/time, optional
• type, string one of tracker,camera,socket, optional

return:

errors:

• 212 - Requested limit is too big (more maxHistoryLimit config option)

count/

parameters:

• from - optional
• type - optional

return:

read(...)

parameters:

return:

errors:

• 201 (Not found in database) - if there is no map layer with such ID belonging to current user

list(...)

return:

errors:

• No specific errors

upload()

parameters:

return:

errors:

• 233 (No data file - if file part is missing
• 234 (Invalid data format - if file has wrong mime type
• 242 (Validation error - if uploaded file is not valid KML
• 268 (Over quota - if the user's quota for map layers is exceeded

update(...)

parameters:

return:

errors:

• 201 (Not found in database) - if there is no map layer with such ID belonging to current user

delete(...)

parameters:

return:

errors:

• 201 (Not found in database) - if there is no map layer with such ID belonging to current user

return:

return:

errors:

• 201 - Not found in database.

read (...)

• 201 (Not found in database) - if there is no place with such ID

list (...)

• general types only

create (...)

• 268 (Over quota) - if the user's quota for places is exceeded

update (...)

• 201 (Not found in database) - if there is no place with such ID

delete (...)

• 201 (Not found in database) - if there is no place with such ID

Plugin object structure

Example

list (...)

• general types only

• schedule
• tracker

objects

retranslator is:

create (...)

parameters:

• 247 (Entity already exists) - if retranslator with this address, port and login already exists
• 268 (Over quota) - if the user's quota for retranslators is exceeded

delete (...)

parameters:

• retranslator_id

• 201 (Not found in database).

list (...)

get (...)

parameters:

• start - (location JSON object) start of route
• end - (location JSON object) end of route
• waypoints = [ ${location}, ... ] - (optional) list of transitional points.
• point_limit - (optional. int. min=2) If specified, the returned route will be simplified to contain this number of points (or less).
• provider_type - (optional, string, one of progorod|google|osrm) If not specified, the default user provider is used.

• 215 (External service error)
• 218 (Malformed external service parameters)
• 236 (Feature unavailable due to tariff restrictions) - if there is at least one tracker without "routing" tariff feature

Contains API calls to interact with tracks and for getting tracks' points.

API actions

parameters:

• 204 - Entity not found - if there is no tracker with such ID belonging to authorized user.
• 208 - Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
• 211 - Requested time span is too big - if interval between "from" and "to" is too big (maximum value specified in API config).

parameters:

• limit_exceeded - boolean. true if the requested time period exceeds limit specified in a tracker's tariff.
• list - array of JSON objects. List of zero or more JSON objects.

• id - int. Track id.
• start_date - date/time. Track start date, in user's timezone e.g. "2011-06-18 03:39:44".
• start_address - string. Track start address.
• max_speed - int. Maximum speed in km/h, e.g. 96.
• end_date - date/time. Track end date, in user's timezone e.g. "2011-06-18 05:18:36".
• end_address - string. Track end address.
• length - float. Track length in kilometers, e.g. 85.5.
• points - int. Total number of points in a track, e.g. 724.
• avg_speed - int. Average speed in km/h, e.g. 70.
• event_count - int. Number of events on this track. Field will be omitted if "count_events" is false.
• norm_fuel_consumed - float. A consumed fuel on track, litres. Field will be omitted if no vehicle bound to tracker or no normAvgFuelConsumption defined in a vehicle.
• type - enum: regular, single_report, merged, cluster. Used to distinguish this track type (regular) from the others.
• gsm_lbs - optional boolean. GSM LBS point flag.

• id - int. Track id.
• start_date - date/time. Track start date, in user's timezone e.g. "2011-06-18 03:39:44".
• start_address - string. Point address.
• avg_speed - int. Average speed in km/h, e.g. 70.
• gsm_lbs - optional boolean. GSM LBS point flag.
• type - enum: regular, single_report, merged, cluster. Used to distinguish this track type (single_report) from the others.
• precision - optional int. Location precision, meters.

• start_date - date/time. Track start date, in user's timezone e.g. "2011-06-18 03:39:44".
• start_address - string. Track start address.
• max_speed - int. Maximum speed in km/h, e.g. 96.
• end_date - date/time. Track end date, in user's timezone e.g. "2011-06-18 05:18:36".
• end_address - string. Track end address.
• length - float. Track length in kilometers, e.g. 85.5.
• points - int. Total number of points in a track, e.g. 724.
• avg_speed - int. Average speed in km/h, e.g. 70.
• event_count - int. Number of events on this track. Field will be omitted if "count_events" is false.
• norm_fuel_consumed - float. A consumed fuel on track, litres. Field will be omitted if no vehicle bound to tracker or no normAvgFuelConsumption defined in a vehicle.
• type - enum: regular, single_report, merged, cluster. Used to distinguish this track type (merged) from the others.
• gsm_lbs - optional boolean. GSM LBS flag.

• start_date - date/time. Track start date, in user's timezone e.g. "2011-06-18 03:39:44".
• start_address - string. Track start address.
• end_date - date/time. Track end date, in user's timezone e.g. "2011-06-18 05:18:36".
• precision - optional int. Location precision, meters.
• points - array of points in a cluster.
• type - enum: regular, single_report, merged, cluster. Used to distinguish this track type (cluster) from the others.
• gsm_lbs - optional boolean. GSM LBS flag, true if cluster contains only GSM LBS points.

• 204 - Entity not found - if there is no tracker with such ID belonging to authorized user.
• 208 - Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
• 211 - Requested time span is too big - if interval between "from" and "to" is too big (maximum value specified in API config).

parameters:

• limit_exceeded - boolean. true if requested time period exceeds limit specified in a tracker's tariff.
• lat - float. Latitude.
• lng - float. Longitude.
• alt - int. Altitude in meters.
• satellites - int. Number of satellites used in fix for this point.
• get_time - date/time. GPS timestamp of the point, in user's timezone.
• address - string. Point address. Will be "" if no address recorded.
• heading - int. Bearing in degrees (0..360).
• speed - int. Speed in km/h.
• precision - optional int. Precision in meters.
• gsm_lbs - optional boolean. true if location detected by GSM LBS.
• parking - optional boolean. true if point does not belong to track.
• buffered - optional boolean. true if point was saved in device memory and transferred to server later.

• 204 - Entity not found - if there is no tracker with such ID belonging to authorized user.
• 208 - Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
• 211 - Requested time span is too big - if interval between "from" and "to" is too big (maximum value specified in API config).

This document contains tracker object structure and API calls to interact with it. Tracker is one of the key entities in our API. It represents tracking device registered in our GPS monitoring system. Lots of API calls created for manipulation of tracker and/or its properties.

• id - int. Tracker id aka object_id.
• label - string. Tracker label.
• clone - boolean. true if this tracker is clone.
• group_id - int. Tracker group id, 0 when no group.
• avatar_file_name - string. Optional. Passed only if present.
• source - object.
• id - int. Source id.
• device_id - string. Device id aka source_imei.
• model - string. Tracker model name from "models" table.
• blocked - boolean. true if tracker blocked due to tariff end.
• tariff_id - int. An id of tracker tariff from "main_tariffs" table.
• status_listing_id - int. An id of the status listing associated with this tracker, or null.
• creation_date - date/time. Date when the tracker registered.
• tariff_end_date - date/time. Date of next tariff prolongation, or null.
• phone - string. Phone of the device. Can be null or empty if device has no GSM module or uses bundled SIM which number hidden from the user.
• tag_binding - object. List of attached tags. Appears only for tracker/list call.
• tag_id - int. An id of tag. Must be unique for a tracker.
• ordinal - int. Number that can be used as ordinal or kind of tag. Must be unique for a tracker. Max value is 5.

API actions

parameters:

'cURL'

'HTTP GET'

• 201 - Not found in the database - if tracker not found.

parameters:

'cURL'

'HTTP GET'

parameters:

'cURL'

'HTTP GET'

• 13 - Operation not permitted - if tracker already connected to server, or if user has insufficient rights.
• 243 - Device already connected.
• 201 - Not found in the database - if tracker not found.
• 219 - Not allowed for clones of the device - if source tracker is clone itself.
• 252 - Device already corrupted.
• 208 - Device blocked.

parameters:

'cURL'

'HTTP GET'

• 201 - Not found in the database - if tracker not found.
• 249 - Operation available for clones only - if tracker is not clone.
• 203 - Delete entity associated with - if there are some rules or vehicles associated with tracker.

parameters:

'cURL'

• 201 - Not found in the database - if tracker not found.
• 208 - Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason..
• 219 - Not allowed for clones of the device - if specified tracker is a clone.
• 214 - Requested operation or parameters are not supported by the device - if device does not have GSM module.
• 223 - Phone number already in use - if specified phone number already used in another device.
• 241 - Cannot change phone to bundled sim. Contact tech support. If specified phone number belongs tp sim card bundled with the device.

Contains the vehicle object and API calls to interact with it. This object is used to describe vehicle's information like VIN, speed, consumption and other. Vehicle object should be assigned to tracker object.

• id - int. An id of a vehicle.
• tracker_id - int. An id of the tracker (aka "object_id"). Tracker must belong to authorized user and not be blocked.
• label - string. Vehicle's label.
• max_speed - int. Maximum speed of a vehicle.
• model - string. Vehicle's model.
• type enum. Vehicle's type. Can be "truck" | "car" | "bus" | "special".
• subtype - optional enum. Depends on type, null means undefined.
• garage_id - nullable int. An id of a garage.
• trailer - optional string. Information about a trailer.
• manufacture_year - optional int. Manufacture year of a vehicle.
• color - optional string. Not RGB. A color of a vehicle.
• additional_info - optional string. Additional info about a vehicle.
• reg_number - string. Reg number/ license plate of a vehicle.
• vin - string. VIN of a vehicle.
• chassis_number - string. Chassis number of a vehicle.
• frame_number - optional string. Frame number of a vehicle.
• payload_weight - int. Payload weight in kilograms.
• payload_height - decimal. Payload height in millimeters.
• payload_length - decimal. Payload length in millimeters.
• payload_width - decimal. Payload width in millimeters.
• passengers - int. A maximum count of passengers.
• gross_weight - optional int. Gross weight in kilograms.
• fuel_type - enum. Can be "petrol" | "diesel" | "gas".
• fuel_grade - string. Grade of fuel used in a vehicle.
• norm_avg_fuel_consumption - decimal. Normal average fuel consumption in liters per 100 km.
• fuel_tank_volume - int. Fuel tank capacity in liters.
• fuel_cost - optional decimal. Cost of fuel used in a vehicle per liter.
• wheel_arrangement - string. Wheel arrangement of a vehicle.
• tyre_size - string. Tyre size.
• tyres_number - int. Number of tyres.
• liability_insurance_policy_number - string. Liability insurance policy number.
• liability_insurance_valid_till - string date. The date till liability insurance valid.
• free_insurance_policy_number - string. Free insurance policy number.
• free_insurance_valid_till - string date. The date till free insurance valid.
• icon_id - nullable int. Can only be updated via avatar/assign.
• avatar_file_name - string. File name.
• tags - int array. List of tag ids.

API actions

parameters:

'cURL'

• 247 - Entity already exists, if tracker_id!=null and exists a vehicle that already bound to this tracker_id.

parameters:

'cURL'

'HTTP GET'

• 201 - Not found in the database - if there is no vehicle with such an id.

'cURL'

• General types only.

parameters:

'cURL'

'HTTP GET'

• 201 - Not found in the database - if there is no vehicle with such an id.

parameters:

'cURL'

• 201 - Not found in the database - if there is no vehicle with such an id.
• 247 - Entity already exists, if tracker_id!=null and exists a vehicle that already bound to this tracker_id.
• 261 - Entity has external links - when tracker_id changes and there are some service tasks associated with this vehicle.

Geofences used in rules to limit rule area of activity. Also, geofence names shown in reports after the address, if an event happened inside the geofence.

This document describes CRUD actions for geofences. Note that geofence points handled separately because they are represented by big arrays of data.

• id - int. Geofence ID.
• label - string. Geofence label.
• address - string. Geofence address.
• color - string. Geofence color in 3-byte RGB hex format.
• radius - int. Circle radius in meters.
• center - location object. Location of circle center.
• tags - int array. Array of tag IDs.

• id - int. Geofence ID.
• label - string. Geofence label.
• address - string. Geofence address.
• color - string. Geofence color in 3-byte RGB hex format.
• tags - int array. Array of tag IDs.

• id - int. Geofence ID.
• label - string. Geofence label.
• address - string. Geofence address.
• color - string. Geofence color in 3-byte RGB hex format.
• radius - int. Polyline radius in meters.
• tags - int array. Array of tag IDs.

API actions

parameters:

'cURL'

• id - int. Geofence ID.
• label - string. Geofence label.
• address - string. Geofence address.
• color - string. Geofence color in 3-byte RGB hex format.
• radius - int. Circle radius in meters.
• center - location object. Location of circle center.
• tags - int array. Array of tag IDs.
• limit_exceeded - boolean. true if given batch constrained by limit.

• 234 - Invalid data format.

parameters:

'cURL'

• 202 - Too many points in a geofence - max allowed points count for a geofence is 100 for a polygon or 1024 for sausage.
• 230 - Not supported for this entity type - if "points" were specified, but geofence cannot have any points associated with it (e.g. if geofence is circle).
• 268 - Over quota - if the user's quota for geofences exceeded.

parameters:

'cURL'

• 201 - Not found in the database.
• 203 - Delete entity associated with.

'cURL'

'HTTP GET'

• list - array of objects. Geofence objects without points field.

parameters:

'cURL'

• 201 - Not found in the database - if geofence with the specified ID cannot be found or belongs to another user.
• 231 - Entity type mismatch - if type of the submitted geofence differs from type of the geofence currently stored in the database.

Transaction object description and API call to get list of user's billing transactions for the specified period.

• description - string. Transaction description.
• type - enum. Type of transaction.
• subtype - enum. Subtype of transaction.
• timestamp - date/time. When transaction created.
• user_id - int. ID of a user which made a transaction.
• dealer_id - int. ID of a dealer.
• tracker_id - int. Tracker id. 0 if transaction not associated with tracker.
• amount - double. Amount of money in transaction, can be negative. e.g. -10.0000 means 10 money units removed from user`s balance.
• new_balance - double. User`s money balance after transaction.
• old_balance - double. User`s money balance before transaction.
• bonus_amount - double. Amount of bonus used in transaction, can be negative. e.g. 10.0000 means 10 bonuses units added to user`s bonus balance.
• new_bonus - double. User`s bonus balance after transaction.
• old_bonus - double. User`s bonus balance before transaction.

API actions

parameters:

'cURL'

• list - array of objects. List of transactions objects.

• 211 - Requested time span is too big - more than report.maxTimeSpan.

A user account lets you start working with the platform as well as customize your experience within it. Contains user object structure and API calls to interact with users.

• paas_id - int. Dealer id.
• paas_settings - object. The same as settings in /dealer/get_ui_config response.
• user_info - object. Info about user.
• id - int. User id.
• login - string. User's login (in most cases it's an email address).
• title - string. User first and last name or organization title.
• phone - string. User phone (if not empty).
• creation_date - date/time. User registration date/time.
• balance - float. User balance, max. 2 digits after dot. For sub-users, this field should be ignored.
• bonus - float. User bonus, max. 2 digits after dot. For sub-users, this field should be ignored.
• locale - enum. User locale, for example "en_EN".
• demo - boolean. true if this is a demo user, false otherwise.
• verified - boolean. true if user email already verified.
• legal_type - enum. Can bed "legal_entity", "individual" or "sole_trader".
• default_geocoder - enum. User's default geocoder. Can be "google", "yandex", "progorod", "osm", or "locationiq".
• route_provider - enum. User's route provider. Can be "progorod", "google" or "osrm".
• time_zone - enum. User timezone name.
• measurement_system - enum. User's measurement system "metric", "imperial", "us", "metric_gal_us" or "nautical".
• tin - string. Taxpayer identification number aka "VATIN" or "INN".
• iec - optional string. Industrial Enterprises Classifier aka "KPP". Used in Russia for legal entities.
• post_country - string. Country part of user's post address.
• post_index - string. Post index or ZIP code.
• post_region - string. Region part of post address (oblast, state, etc.).
• post_city - string. City from postal address.
• post_street_address - string. Street address.
• registered_country - string. Country part of user's registered address.
• registered_index - string. Index part of user's registered address.
• registered_region - string. Region part of user's registered address.
• registered_city - string. City from registered address.
• registered_street_address - string. User's registered address.
• first_name - string. User's or contact person first name.
• middle_name - string. User's or contact person middle name.
• last_name - string. User's or contact person last name.
• legal_name - optional string. A juridical name.
• master - object. Returned only if current user is sub-user. All fields have same meaning as in "user_info", but for master user's account.
• tariff_restrictions - tariff restrictions object, for more info see user/get_tariff_restrictions.
• allowed_maps - string array. List of allowed maps.
• premium_gis - boolean. true if a dealer has premium GIS tariff.
• features - string array. Set of allowed Dealer features.
• privileges - object only returned for sub-users. Describes effective sub-user privileges.
• rights - string array. A set of rights granted to sub-user. Described in security group rights.

API actions

parameters:

'cURL'

• hash - string. Session hash.

• 11 - Access denied - if dealer blocked.
• 102 - Wrong login or password.
• 103 - User not activated.
• 104 - Logins limit exceeded, please reuse existing sessions instead (see also user/session/renew).
• 105 - Login attempts limit exceeded, try again later.

parameters:

'cURL'

• user_object - for more info see user object structure.

• General types only.

parameters:

'cURL'

• allowed_maps - string array. List of allowed maps.

• General types only.

parameters:

'cURL'

• General types only.

parameters:

'cURL'

• 201 - Not found in the database - user with a passed login not found.
• 209 - Failed sending email - can't send email.
• 264 - Timeout not reached - previous activation link generated less than 5 minutes ago (or other configured on server timeout).
  
  
  {
     "success": false,
     "status": {
        "code": 264,
        "description": "Timeout not reached"
     },
     "timeout": "PT5M",
     "remainder": "PT4M31.575S"
  
  }
  
  
• timeout - string. timeout between sending activation links in ISO-8601 duration format.
• remainder - string. remaining time to next try in ISO-8601 duration format
• 265 - Already done - user already activated and verified.

Statuses are used to track current employee activity (in fact, of tracking devices owned by employees). The simplest example is "busy" | "not busy". This is a status listing consisting of two elements (working statuses). Different trackers can be assigned different status lists.

'cURL'

'cURL'

'cURL'

API calls to interact with payment subscriptions

API actions

/subscription/avangate/

Cancel

parameters:

'cURL'

• 215 - External service error.

list

parameters:

'cURL'

• reference - string. Internal 2Checkout (formerly Avangate) subscription code. Pass it to /subscription/avangate/cancel.
• code - string. 2Checkout (formerly Avangate) product code.
• quantity - int. Count.
• expiration_date - date/time. Next renew date/time.

• 215 - External service error.

Contains API calls related to sub-users, that is, additional users who have access to your account and monitoring assets. Sub-users is a convenient way for corporate clients to provide multiple employees, who have different roles and privileges, with access to the monitoring system.

"Usual" user account called "master account" in relation to sub-users.

Every sub-user can operate on a subset of trackers from your "master account". Every entity, which is associated with unavailable trackers, also becomes hidden from sub-user. This is called "scoping". Sub-users' rights can also be limited to prevent unauthorized changes to your data and application setting.

NOTE: Sub-users cannot have any "exclusive" objects. Every tracker, rule, task, etc., even created or edited by sub-user, still belongs to your account. The only exception is reporting system: every sub-user has its own reports pool and reports schedule.

• id - int. Sub-user id, can be null (when creating new sub-user).
• activated - boolean. true if sub-user activated (allowed to login)
• login - string. Sub-user email as login. Must be valid unique email address.
• first_name - string. Sub-user's or contact person first name./li>
• middle_name - string. Sub-user's or contact person middle name.
• last_name - string. Sub-user's or contact person last name.
• legal_type - enum. Can bed "legal_entity", "individual" or "sole_trader".
• phone - string. Sub-user's or contact phone (10-15 digits).
• post_country - string. Country part of sub-user's post address.
• post_index - string. Index part of sub-user's post address.
• post_region - string. Region part of sub-user's post address.
• post_city - string. City from postal address.
• post_street_address - string. Street address.
• registered_country - string. Country part of sub-user's registered address.
• registered_index - string. Index part of sub-user's registered address.
• registered_region - string. Region part of sub-user's registered address.
• registered_city - string. City from registered address.
• registered_street_address - string. Sub-user's registered address.
• state_reg_num - string. State registration number. E.g. EIN in USA, OGRN in Russia. 15 characters max.
• tin - string. Taxpayer identification number aka "VATIN" or "INN".
• legal_name - string. Sub-user's legal name (for "legal_entity" only).
• iec - optional string. Industrial Enterprises Classifier aka "KPP" (used in Russia. For "legal_entity" only).
• security_group_id - int. An id of the security group to which sub-user belongs to. Can be null, which means default group with no privileges.
• creation_date - date/time. Date and time when sub-user was created. This field is read-only, it should not be used in subuser/update.

API actions

delete

parameters:

'cURL'

• 13 - Operation not permitted - if user has insufficient rights.
• 236 - Feature unavailable due to tariff restrictions - if there is at least one tracker without multilevel_access tariff feature.
• 201 - Not found in the database - if sub-user with such an id does not exist or does not belong to current master user.

list

parameters:

'cURL'

• list - array of objects. List of all sub-users belonging to this master account.

• 13 - Operation not permitted - if user has insufficient rights.
• 236 - Feature unavailable due to tariff restrictions - if there is at least one tracker without multilevel_access tariff feature.

register

parameters:

'cURL'

• id - int. An id of the created sub-user.

• 13 - Operation not permitted - if user has insufficient rights.
• 236 - Feature unavailable due to tariff restrictions - if there is at least one tracker without multilevel_access tariff feature.
• 201 - Not found in the database - when specified security_group_id does not exist.
• 206 - login already in use - if this login email already registered.

update

parameters:

'cURL'

• 13 - Operation not permitted - if user has insufficient rights.
• 236 - Feature unavailable due to tariff restrictions - if there is at least one tracker without multilevel_access tariff feature.
• 201 - Not found in the database - if sub-user with such an id does not exist or does not belong to current master user. Also, when specified security_group_id does not exist.

Set tags for a tracker. Tags must be created.

parameters:

'cURL'

• General types only.

API calls for interaction with tariff plans.

• id - int. Tariff ID.
• name - string. Tariff name.
• group_id - int. Tariff group number.
• active - boolean. true if user allowed change his current tariff to this one.
• type - enum. Type of tariff. Can be "monthly" or "activeday" (for "tracker" device_type only).
• price - double. Tariff subscription price (usually per month).
• early_change_price - double. Price of change tariff from current to other. With the last change in less than 30 days (tariff.freeze.period config option). When not passed or null user cannot change tariff frequently.
• device_limit - int. A maximum limit of devices per user. Not used for cameras and sockets.
• has_reports - boolean. If true the tariff has reports.
• store_period - string. Data storage period, e.g. "2h" (2 hours), "3d" (3 days), "5m" (5 months), "1y" (one year).
• device_type - enum. Device type. Can be "tracker", "camera" or "socket".
• proportional_charge - boolean. true if monthly fee will be smaller when device was blocked during month (for "monthly" tariffs only).
• service_prices - JSON object with service prices.
• incoming_sms - double. Incoming sms price.
• outgoing_sms - double. Outgoing sms price.
• service_sms - double. Service sms price.
• phone_call - double. Phone voice notification sms price.
• traffic - double. Traffic price per 1 MB.

API actions

create

parameters:

'cURL'

• id - int. An id of the created tariff.

• 201 - Not found in the database - if specified tariff does not exist or belongs to different dealer.
• 214 - Requested operation or parameters are not supported by the device - when device_type does not support specified tariff type.
• 244 - Duplicate entity label - if there's another dealer's tariff with the same name.

list

parameters:

'cURL'

• list - objects array. List of tariff plans.
• wholesale_service_prices - JSON object. Wholesale prices for all services (what dealer will pay per sms, per call, per mb).
• count - int. Total number of records (ignoring offset and limit).

read

parameters:

'cURL'

• value - JSON object.

• 201 - Not found in the database - if specified tariff does not exist or belongs to different dealer.

update

parameters:

'cURL'

• 201 - Not found in the database - if specified tariff does not exist or belongs to different dealer.
• 214 - Requested operation or parameters are not supported by the device when device_type does not support specified tariff type.
• 244 - Duplicate entity label - if there's another dealer's tariff with the same name.

Contains an API call to get information about all supported timezones.

API actions

list

parameters:

'cURL'

• zone_id - string. Timezone ID, which is used throughout the API.
• description - string. Localized description of the timezone.
• base_offset - double. Base timezone offset in hours, e.g. 10 means UTC +10. May be negative or fractional!
• dst_offset - int. DST offset in hours (0 if no DST rules for this timezone).
• country_code - string. ISO country code for the timezone.
• alt_ids - string array. List of strings, optional, alternative timezone IDs.

• General types only.

You can assign task to any tracked device. If specified tracker visits task checkpoint at the specified time and meets other conditions such as filling form or staying in the task zone for the specified time, the task completed. Otherwise, the task either failed completely or completed with warnings.

If task assigned to a Mobile Tracker App (Android / iOS), it's available for viewing by app user. User will also receive notifications of newly assigned tasks, task changes, etc.

• id - int. Primary key. Used in task/update, IGNORED in task/create.
• user_id - int. User id. IGNORED in create/update.
• tracker_id - int. An id of the tracker to which task assigned. Can be null. IGNORED in task/update.
• location - location associated with this task. Cannot be null.
• address - string. Address of the location.
• radius- int. Radius of location zone in meters.
• creation_date - date/time. When task created. IGNORED in create/update.
• from - date/time. Date AFTER which task zone must be visited.
• to - date/time. Date BEFORE which task zone must be visited.
• external_id - string. Used if task imported from external system. Arbitrary text string. Can be null.
• status - enum. Task status. IGNORED in create/update. Can have "unassigned" value (unassigned to any executor), "assigned", "done", "failed", "delayed", "arrived" (arrived to geofence but haven't done the task), "faulty" (with problems).
• status_change_date - date/time. When task status changed. IGNORED in create/update.
• max_delay - int. Maximum allowed task completion delay in minutes.
• min_stay_duration - int. Minimum duration of stay in task zone for task completion, minutes.
• arrival_date - date/time. When tracker has arrived to the task zone. IGNORED in create/update.
• stay_duration - int. Duration of stay in the task zone, seconds.
• origin - string. Task origin. IGNORED in create/update.
• tags - int array. List of tag ids.
• form - form object. If present.
• form_template_id - int. An id of form template. Used in create and update actions only if create_form parameter is true in them.
• fields - optional object. A map, each key of which is a custom field id as a string. See entity/fields

API actions

assign

parameters:

'cURL'

• 201 - Not found in the database (if there is no task with such an id).
• 204 - Entity not found (if there is no tracker with such id belonging to authorized user).
• 208 - Device blocked (if tracker exists but was blocked due to tariff restrictions or some other reason).
• 255 - Invalid task state (if current task state is not "unassigned" or "assigned").
• 236 - Feature unavailable due to tariff restrictions (if device's tariff does not allow usage of tasks).

batch_convert

parameters:

• list - list of checked task objects that contain all fields from task and field errors.
• errors - array of objects. Optional. List of errors.
• limit_exceeded - boolean. true if given batch constrained by a limit.

• General types only.

count

'cURL'

• count - int. Number of tasks.

create

parameters:

'cURL'

• id - int. An id of the created task.

• 201 - Not found in the database (if task.tracker_id is not null and belongs to nonexistent tracker).
• 236 - Feature unavailable due to tariff restrictions (if device's tariff does not allow usage of tasks).

delete

parameters:

'cURL'

• 201 - Not found in the database (if there is no task with such an id).

list

parameters:

'cURL'

• list - array of task objects.
• id - int. Task id.
• user_id - int. User id (office). An unchangeable parameter.
• tracker_id - int. Tracker ID. Indicator ID by which the implementation of this task will be controlled.
• location - area (circle geofence), entering and leaving of geofence will be controlled.
• label - string. Task name, length 1-200 characters.
• description - string. Task description, length 0-1024 characters.
• creation_date - date/time. Date of creation of a task, unchangeable field.
• from - date/time. Start date of the interval - when the specified location has to be visited (in the user's time zone).
• to - date/time. End date of the interval - when the specified location has to be visited (in the user's time zone).
• external_id - string. Text field for tracking of communication of the task with certain external systems (for example, number of the order). Is for reference only.
• status - enum. Current status of a task, can have "unassigned" value (unassigned to any executor), "assigned", "done", "failed", "delayed", "arrived" (arrived to geofence but haven't done the task), "faulty" (with problems).
• status_change_date - date/time. Date of the last change of the status of a task.
• max_delay - int. The maximum time delay of the execution of the task, in minutes.
• min_stay_duration - int. The minimum stay time in the area of the task in which the task has to be done, in minutes.
• arrival_date - date/time. Date and time of arrival in the area of the task. Can be null. If the executor has not visited it yet.
• stay_duration - int. Number of seconds spent inside task zone.
• origin - enum. The way of creation of a task. Can be "manual", "scheduled" or "imported" (from excel).
• type - string. Reserved.
• count - int. count of the all found tasks.

• General types only.

read

parameters:

'cURL'

• value - JSON object.
• checkpoints - only returned if entity with specified id is a route. Contains all checkpoints of this route.

• 201 - Not found in the database (if there is no task with such an id).

transmute

parameters:

'cURL'

• 201 - Not found in the database (if there is no task or route with such an id, or tracker to which checkpoint assigned is unavailable to current sub-user).
• 255 - Invalid task state (if task or any of the checkpoints are not in unassigned or assigned state).

update

parameters:

'cURL'

• 201 - Not found in the database (if there is no task with such an id).
• 255 - Invalid task state (if current task state is not "unassigned" or "assigned").