Skip to content

Subpaas actions

Dealer means parent of subpaas.

dealer_block_type type is enum object:

  • NOT_BLOCKED
  • INITIAL_BLOCK
  • BLOCK_LOGIN
  • CLIENTS_BLOCKED
  • DELETED

API base path: /subpaas

create

Create subpaas. After creation its dealer_block_type will be in INITIAL_BLOCK status

parameters

  • passwordstring. Subpaas's password
  • titlestring. Subpaas's name
  • emailstring. Company email
  • jur_namestring. Legal (juristic) company name
  • link_monitoringstring. Subpaas's domain name
  • jur_countrystring. Subpaas's country

errors

  • 13 – If the dealer
    • is not paas
    • has different status than NOT_BLOCKED
    • his tariff doesn't allow subpaases

response

{ "success": true }

list

Get list of all subpaases for dealer. Dealer id will be taken from the session.

parameters

  • order_bystring (default: subpaas_id). Sort option. Possible values:
    — subpaas_id
    — title
    — jur_name
    — login
    — block_type
    — creation_date
  • ascendingboolean (default: true). If true, ordering will be ascending, descending otherwise.
  • limitint. Pagination. Maximum subpaases to return, e.g. 10
  • offsetint. Pagination. Get subpaases starting from, e.g. 0

errors

  • 13 – If the dealer
    • is not paas
    • has different status than NOT_BLOCKED
    • his tariff doesn't allow subpaases

response

{
  "success": true,
  "list": [
    {
      "subpaas_id": 18,
      "title": "SubppaasTitle",
      "jur_name": "SubppaasJurName",
      "login": "subpaaslogin",
      "creation_date": "2018-11-15",
      "block_type": "NOT_BLOCKED", // <dealer_block_type>
      "users_count": 2,
      "active_users_count": 1,
      "trackers_count": 0,
      "active_trackers_count": 0
    }
  ]
}

read

Get subpaas info by its id.

parameters

  • subpaas_idint. Subpaas id

errors

  • 13 – If the dealer
    • is not paas
    • has different status than NOT_BLOCKED
    • his tariff doesn't allow subpaases

response

{
  "success": true,
  "value": {
    "subpaas_id": 18,
    "block_type": "NOT_BLOCKED", // <dealer_block_type>
    "title": "Rus Sub-PaaS",
    "jur_name": "OOO Sub-PaaS",
    "email": "[email protected]",
    "jur_country": "country",
    "link_monitoring": "link",
    "contact_fio": "fio", // The contact person
    "contact_post": "post", // The contact post (position)
    "contact_phone": "phone" // The contact phone
  }
}

update

Update subpaas.

parameters

  • subpaas_idid. Subpaas's id
  • passwordstring. Subpaas's password
  • titlestring. Subpaas's company name
  • emailstring. Subpaas's email
  • jur_namestring. Legal (juristic) subpaas's company name
  • link_monitoringstring. Subpaas's domain name
  • jur_countrystring. Subpaas's country
  • contact_fiostring. The contact person
  • contact_poststring. The contact post (position)
  • contact_phonestring. The contact phone
  • block_typestring.

errors

  • 13 –
    • The dealer is not paas
    • The dealer has different status than NOT_BLOCKED
    • The dealer's tariff doesn't allow subpaases
    • block_type is DELETED
    • Found subpaas is in DELETED status
    • Found subpaas is not in INITIAL_BLOCK status and block_type is INITIAL_BLOCK
    • Found subpaas is in INITIAL_BLOCK status and block_type is not INITIAL_BLOCK

response

{ "success": true }

Last update: August 21, 2020