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.
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.
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.
User-defined label. Printable characters, 1 to 60.
CourierTracker group ID, or 0 for no group. The group must exist.
Required when the model uses a fixed device ID.
4568005588562Optional. Default null, meaning follow the platform setting.
The registered tracker
true if request finished successfully.
trueBad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.
Error 13: the user lacks the right. Error 204: the group does not exist. Error 221: the device limit of the TSP is exceeded. Error 224: the device ID is already registered. Error 225: the tariff is not compatible with the account's legal type.
Error response object
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?