Dealers | PortSIP Knowledge Base

List dealers

List a collection of dealers.

GEThttp://127.0.0.1:8888/api/dealers

Response

OK

Body

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

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

Response

{
  "count": 100,
  "items": [
    {
      "id": {},
      "enabled": true,
      "level": "DISTRIBUTOR",
      "name": "text",
      "email": {},
      "display_name": "text",
      "website": "text",
      "phone": "text",
      "address": "text",
      "description": "text",
      "max_tenants": 100,
      "max_extensions": 50000,
      "tenant_full_access": true
    }
  ]
}

Create a dealer

Create a dealer.

POSThttp://127.0.0.1:8888/api/dealers

Body

enabledboolean

Enable this dealer or not.

level*enum

Dealer level includes:

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

DISTRIBUTORSUB_DISTRIBUTORRESELLER

name*string

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.

password*string

The password of dealer.

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_tenants*integer (int32)

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

max_extensions*integer (int32)

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

tenant_full_accessboolean

Whether or not the reseller is allowed to have full control over the tenant.
This attribute is not valid if not modified by first level dealer.

Response

Success

Body

idall of

The unique ID of dealer.

Request

const response = await fetch('http://127.0.0.1:8888/api/dealers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "level": "DISTRIBUTOR",
      "password": "text",
      "max_tenants": 100,
      "max_extensions": 50000
    }),
});
const data = await response.json();

Response

{
  "id": {}
}

Retrieve a dealer

Get details of the dealer by it's unique ID.

GEThttp://127.0.0.1:8888/api/dealers/{id}

Path parameters

id*all of

The unique ID of dealer.

Response

OK

Body

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.

tenant_full_accessboolean

Whether or not the reseller is allowed to have full control over the tenant.
This attribute is not valid if not modified by first level dealer.

Request

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

Response

{
  "id": {},
  "enabled": true,
  "level": "DISTRIBUTOR",
  "name": "text",
  "email": {},
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text",
  "max_tenants": 100,
  "max_extensions": 50000,
  "tenant_full_access": true
}

Update a dealer

Modify the settings of the dealer.

POSThttp://127.0.0.1:8888/api/dealers/{id}

Path parameters

id*all of

The unique ID of dealer.

Body

enabledboolean

Enable this dealer or not.

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.

tenant_full_accessboolean

Whether or not the reseller is allowed to have full control over the tenant.
This attribute is not valid if not modified by first level dealer.

Response

OK

Request

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