Dealer

Retrieve current dealer

Get details of current dealer.

GEThttp://127.0.0.1:8888/api/dealer

Response

2004XX

OK

Body

application/json

idall of

The unique ID of dealer.

enabledboolean

Enable this dealer or not.

levelenum

Dealer level includes:

• DISTRIBUTOR: the first level of dealers.
• SUB_DISTRIBUTOR: the second level of dealers.
• RESELLER: the third level of dealers.

DISTRIBUTORSUB_DISTRIBUTORRESELLER

namestring

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

emailall of

The email address of user.

display_namestring

The display name of user.

websitestring

The website of user.

phonestring

The mobile phone number of user.

addressstring

The address.

descriptionstring

The description of dealer.

max_tenantsinteger (int32)

The maximum number of tenants that the dealer is allowed to create.

max_extensionsinteger (int32)

The maximum number of extensions that the dealer is allowed to create.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/dealer', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "enabled": true,
  "level": "DISTRIBUTOR",
  "name": "text",
  "email": {},
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text"
}

Update current dealer

Modify the settings of the current dealer.

POSThttp://127.0.0.1:8888/api/dealer

Body

application/json

emailall of

The email address of user.

display_namestring

The display name of user.

websitestring

The website of user.

phonestring

The mobile phone number of user.

addressstring

The address.

descriptionstring

The description of dealer.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/dealer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();