Dealer

API call to get information about a dealer.

In Navixy, a Dealer is an entity that acts as a reseller or distributor of the Navixy platform services. Dealers have access to the Navixy Admin Panel, where they can manage various aspects of the platform, including users, devices, and service plans.

Dealer object

Notes on individual fields:

• features lists the allowed dealer features.

• default_user_time_zone is a time zone ID applied to users created via user/upload. The same zone is preselected when creating a user in the Navixy Admin Panel.

• store_period on the dealer applies to users on a demo_tariff. The store_period inside tariff is the plan's own maximum data store period. The two are separate values.

• password_policy reports the complexity rules enforced for this dealer, and applies to dealer/password/update as well as to end user passwords.

API Actions

API Path: panel/dealer/

---

Required Permissions:

• base: "get_dealer_info".

Get dealer info

post

/panel/dealer/get_info

Read information about the authorized dealer: PaaS plan and its service prices, balance, active tracker counts and limits, branding paths, block status, enabled features, and defaults applied to newly created users. Takes no parameters beyond the session credential. Note that the dealer fields are returned at the top level of the response rather than nested under a value key.

Authorizations

AuthorizationstringRequired

Enter the panel session hash with the "NVX " prefix, e.g. "NVX fa7bf873fab9333144e171372a321b06". Obtain the hash from the accountAuth operation.

Responses

200

Dealer information

application/json

A dealer: a reseller or distributor of Navixy platform services, with access to the Admin Panel.

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

idintegerOptional

Dealer ID.

Example: 9000

seller_idintegerOptional

ID of the seller this dealer buys from.

Example: 3

parent_dealer_idintegerOptional

Parent dealer ID.

Example: 5001

contract_typestring · enumOptional

Contract type.

Example: PAASPossible values:

tariff_idintegerOptional

PaaS plan ID.

Example: 5

demo_tariffbooleanOptional

true for trial PaaS plans.

Example: false

tracker_tariff_end_datestring · nullableOptional

End date of the tracker plan.

Example: 2015-12-31

store_periodstringOptional

Maximum data store period for users on a demo_tariff, as an ISO 8601 duration.

Example: P6M

demo_endsstring · nullableOptional

Trial period end date, or null if not on a trial.

titlestringOptional

Dealer display name.

Example: Navixy Demo

block_statusstring · enumOptional

Block status of the panel and its end users.

Example: NOT_BLOCKEDPossible values:

legal_namestringOptional

Dealer legal name.

Example: Company

active_amountintegerOptional

Total number of active trackers, including those of sub-dealers.

Example: 99

active_amount_ownintegerOptional

Number of active trackers, excluding those of sub-dealers.

Example: 80

active_amount_subpaasintegerOptional

Number of active trackers belonging to sub-dealers.

Example: 19

active_limitintegerOptional

Maximum number of active trackers allowed.

Example: 100

localestringOptional

Dealer's default locale.

Example: en_US

domainstringOptional

Dealer's domain.

Example: demo.navixy.com

faviconstring · nullableOptional

Path or URL to the dealer's interface favicon.

Example: paas/5001/custom.ico

logostring · nullableOptional

Path or URL to the dealer's logotype.

Example: paas/5001/logo.png

subpaasbooleanOptional

true if this dealer is itself a sub-dealer of another.

Example: false

allow_brandingbooleanOptional

true if the dealer's plan permits branding customization.

Example: true

paas_activation_datestring · nullableOptional

Date the activation payment was made.

Example: 2015-03-01

license_balancenumberOptional

Current license balance.

Example: 0

seller_currencystringOptional

Currency the seller bills this dealer in.

Example: USD

featuresstring[]Optional

Enabled dealer features.

Example: ["branding_web","branding_mobile","navixy_label","tracking","reports","fleet","field_service","premium_gis"]

default_user_time_zonestringOptional

Time zone ID applied to users created through the user upload operation, and preselected when creating a user in the Admin Panel.

Example: Europe/London

standalone_tokenstringRead-onlyOptional

Service token, present only on standalone (on-premise) installations. Omitted entirely on Navixy-hosted platforms.

400

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

application/json

403

Operation not permitted, error code 13: the session lacks the required permission.

application/json

default

Error response object

application/json

post/panel/dealer/get_info

POST /v2/panel/dealer/get_info HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "id": 9000,
  "seller_id": 3,
  "parent_dealer_id": 5001,
  "contract_type": "PAAS",
  "tariff_id": 5,
  "tariff": {
    "id": 5,
    "name": "PaaS Tariff",
    "type": "daily",
    "algorithm": "plain",
    "gis_package": "premium",
    "currency": "RUB",
    "license_price": null,
    "min_license_pay": null,
    "vat": false,
    "trial": false,
    "premium_gis": true,
    "service_prices": {
      "incoming_sms": 0.3,
      "outgoing_sms": 0.3,
      "service_sms": 0.2,
      "traffic": 0.09
    },
    "store_period": "P3Y"
  },
  "demo_tariff": false,
  "tracker_tariff_end_date": "2015-12-31",
  "store_period": "P6M",
  "demo_ends": null,
  "title": "Navixy Demo",
  "block_status": "NOT_BLOCKED",
  "legal_name": "Company",
  "active_amount": 99,
  "active_amount_own": 80,
  "active_amount_subpaas": 19,
  "active_limit": 100,
  "locale": "en_US",
  "domain": "demo.navixy.com",
  "favicon": "paas/5001/custom.ico",
  "logo": "paas/5001/logo.png",
  "subpaas": false,
  "allow_branding": true,
  "password_policy": {
    "min_length": 12,
    "max_length": 20,
    "special_chars": "!@#$%^&*-=()<>[]{}+:;.,/\\?|~`'\"",
    "min_special_chars_count": 1,
    "min_digits_count": 1,
    "min_uppercase_count": 1,
    "min_lowercase_count": 1
  },
  "paas_activation_date": "2015-03-01",
  "license_balance": 0,
  "seller_currency": "USD",
  "features": [
    "branding_web",
    "branding_mobile",
    "navixy_label",
    "tracking",
    "reports",
    "fleet",
    "field_service",
    "premium_gis"
  ],
  "default_user_time_zone": "Europe/London",
  "standalone_token": "text"
}

Errors

• 201 - Not found in the database.