For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mobile app register

Deprecated. Register a mobile application as a tracker.

This operation registered a phone running the mobile application as a tracker in its own right. It still answers, and is documented here because it is still reachable, but tracker/register covers the same ground and is maintained.

As with tracker/register, the chosen registration plugin adds its own parameters on top of the ones the operation lists. The group must already exist. List groups with group/list. Models with a fixed device ID are listed by tracker/list_models. The call returns a tracker object.

API actions

API base path: /tracker/mobile.


Required sub-user rights: tracker_register.

Register a mobile application (deprecated)

post
/tracker/mobile/register

Deprecated. Do not use. Register a new mobile client application.

Use tracker/register with plugin_id 35 instead. As with that call, the chosen registration plugin adds its own parameters on top of the ones below.

Requires the tracker_register right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
labelstring · min: 1 · max: 60Required

User-defined label. Printable characters, 1 to 60.

Example: Courier
group_idintegerRequired

Tracker group ID, or 0 for no group. The group must exist.

device_idstringOptional

Required when the model uses a fixed device ID.

Example: 4568005588562
send_register_commandsboolean · nullableOptional

Optional. Default null, meaning follow the platform setting.

Other propertiesanyOptional
Responses
200

The registered tracker

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/tracker/mobile/register
POST /v2/tracker/mobile/register HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "label": "Courier",
  "group_id": 0,
  "device_id": "4568005588562",
  "send_register_commands": null,
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
{
  "success": true,
  "value": {
    "id": 123456,
    "label": "tracker label",
    "clone": true,
    "group_id": 167,
    "avatar_file_name": "text",
    "source": {
      "id": 234567,
      "device_id": "9999999988888",
      "model": "telfmb920",
      "blocked": true,
      "tariff_id": 345678,
      "status_listing_id": null,
      "creation_date": "2011-09-21",
      "tariff_end_date": null,
      "phone": null
    },
    "tag_bindings": [
      {
        "tag_id": 456789,
        "ordinal": 4
      }
    ]
  }
}

Errors

These errors come in addition to the general error codes:

  • 13 - The user lacks the right.

  • 204 - The group does not exist.

  • 221 - The device limit of the telematics service provider (TSP) is exceeded.

  • 224 - The device ID is already registered.

  • 225 - The tariff is not compatible with the account's legal type.

Last updated

Was this helpful?