APN settings by tracker

Look up the mobile-internet settings for a registered tracker, by its ID rather than its phone number.

An access point name, or APN, is the mobile-internet configuration a SIM needs before the device holding it can reach the Navixy platform. This operation looks those settings up for a tracker that is already registered.

The difference from APN settings is what you have to hand. That one takes a phone number and works for any number, registered or not. This one takes a tracker ID and resolves the number from the tracker.

API actions

API base path: /tracker/apn_settings.

---

Required sub-user rights: tracker_register.

Read APN settings by tracker

post

/tracker/apn_settings/read

Get the APN name, user and password configured for a tracker's SIM. The APN is what tells the device how to reach the mobile network.

This is the by-tracker form. apn_settings/read, at the top level, does the same thing by phone number and needs no authentication.

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

tracker_idintegerRequired

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

Example: 123456

Responses

200

The APN settings

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

403

Error 201: no tracker, or no APN settings for it. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 214: the device has no GSM module, or uses a bundled SIM whose details are hidden from the user.

application/json

default

Error response object

application/json

post/tracker/apn_settings/read

POST /v2/tracker/apn_settings/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "tracker_id": 123456
}

{
  "success": true,
  "value": {
    "name": "fast.tmobile.com",
    "user": "tmobile",
    "password": "tmobile"
  }
}

Errors

These errors come in addition to the general error codes:

• 201 - No tracker, or no APN settings for it.

• 208 - The tracker exists but is blocked, normally because its tariff ended.

• 214 - The device has no GSM module, or uses a bundled SIM whose details are hidden from the user.