Skip to content

Subuser geofences

Contains API calls to control which geofences is available to which sub-user.

API actions

API path: /subuser/zones.

bind

Gives access for sub-user to specified geofences.

required tariff features: multilevel_access – for ALL trackers. required sub-user rights: admin (available only to master users).

Parameters

name description type
subuser_id ID of a sub-user belonging to current account. int
access_to_all Optional. If true then sub-user will have access to all geofences of master user. boolean
zone_ids Optional. List of geofence IDs to associate with a specified sub-user. All geofences must belong to current master user. int array

At least one of access_to_all and zone_ids parameters must be not null.

Examples

curl -X POST 'https://api.navixy.com/v2/subuser/zones/bind' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "subuser_id": 204951, "access_to_all": false, "zone_ids": [7548]}'

Response

{
  "success": true
}

Errors

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

unbind

Disables access for sub-user to specified geofences.

required tariff features: multilevel_access – for ALL trackers. required sub-user rights: admin (available only to master users).

Parameters

name description type
subuser_id ID of a sub-user belonging to current account. int
zone_ids List of geofence IDs to associate with a specified sub-user. All geofences must belong to current master user. int array

Examples

curl -X POST 'https://api.navixy.com/v2/subuser/zones/unbind' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "subuser_id": 204951, "zone_ids": [7548]}'

Response

{
  "success": true
}

Errors

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

list_ids

Gets a list of geofence IDs to which this sub-user has access.

required tariff features: multilevel_access – for ALL trackers. required sub-user rights: admin (available only to master users).

Parameters

name description type
subuser_id ID of a sub-user belonging to current account. int

Examples

curl -X POST 'https://api.navixy.com/v2/subuser/zones/list_ids' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "subuser_id": 204951}'

Response

{
  "success": true,
  "access_to_all": true,
  "list" : [7548]
}

Errors

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

list

Gets a list of geofences to which this sub-user has access.

required tariff features: multilevel_access – for ALL trackers. required sub-user rights: admin (available only to master users).

Parameters

name description type
subuser_id ID of a sub-user belonging to current account. int
filter Optional. Filter for geofence label. string
tag_ids Optional. Tag IDs assigned to geofences. Geofences found must include all tags from a list. int array
offset Optional. Offset from start of found geofences for pagination. int
limit Optional. Limit of found geofences for pagination. int
order Optional. Specify list ordering. Can be any of id, label. Default order by id. enum

Examples

curl -X POST 'https://api.navixy.com/v2/subuser/zones/list' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "subuser_id": 204951, "offset": 0, "limit": 1000}'

Response

{
  "success": true,
  "access_to_all": false,
  "list" : [<zone>, ...],
  "count": 12
}

Errors

  • 13 – Operation not permitted – if user has insufficient rights.
  • 201 – Not found in the database – if sub-user with such an ID does not exist or does not belong to current master user.
  • 236 – Feature unavailable due to tariff restrictions (if there is at least one tracker without multilevel_access tariff feature).
Last update: October 16, 2024