Product DocsSchemaAuthentication

Telecom Settings

get

API endpoint that allows users to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/common/telecom_settings/telecom_settings/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
[
  {
    "id": "text",
    "settings_id": "text",
    "module": "text",
    "min_bw_individual": 1,
    "min_bw_corporate": 1,
    "max_bw_corporate": 1,
    "reservation_expiry_period": 1,
    "organization": "text",
    "overprovisioning_factor": 1,
    "auto_reservation": true,
    "is_deleted": true
  }
]
post

API endpoint that allows users to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
settings_idstringOptional
modulestringOptional
min_bw_individualnumber · floatOptional
min_bw_corporatenumber · floatOptional
max_bw_corporatenumber · floatOptional
reservation_expiry_periodnumber · floatOptional
organizationstringOptional
overprovisioning_factornumber · floatOptional
auto_reservationbooleanOptional
is_deletedbooleanOptional
Responses
201Success
application/json
post
POST /ux/common/telecom_settings/telecom_settings/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "settings_id": "text",
  "module": "text",
  "min_bw_individual": 1,
  "min_bw_corporate": 1,
  "max_bw_corporate": 1,
  "reservation_expiry_period": 1,
  "organization": "text",
  "overprovisioning_factor": 1,
  "auto_reservation": true,
  "is_deleted": true
}
201Success
{
  "id": "text",
  "settings_id": "text",
  "module": "text",
  "min_bw_individual": 1,
  "min_bw_corporate": 1,
  "max_bw_corporate": 1,
  "reservation_expiry_period": 1,
  "organization": "text",
  "overprovisioning_factor": 1,
  "auto_reservation": true,
  "is_deleted": true
}
get

API endpoint that allows users to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/common/telecom_settings/telecom_settings/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "settings_id": "text",
  "module": "text",
  "min_bw_individual": 1,
  "min_bw_corporate": 1,
  "max_bw_corporate": 1,
  "reservation_expiry_period": 1,
  "organization": "text",
  "overprovisioning_factor": 1,
  "auto_reservation": true,
  "is_deleted": true
}
put

API endpoint that allows users to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
settings_idstringOptional
modulestringOptional
min_bw_individualnumber · floatOptional
min_bw_corporatenumber · floatOptional
max_bw_corporatenumber · floatOptional
reservation_expiry_periodnumber · floatOptional
organizationstringOptional
overprovisioning_factornumber · floatOptional
auto_reservationbooleanOptional
is_deletedbooleanOptional
Responses
200Success
application/json
put
PUT /ux/common/telecom_settings/telecom_settings/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "settings_id": "text",
  "module": "text",
  "min_bw_individual": 1,
  "min_bw_corporate": 1,
  "max_bw_corporate": 1,
  "reservation_expiry_period": 1,
  "organization": "text",
  "overprovisioning_factor": 1,
  "auto_reservation": true,
  "is_deleted": true
}
200Success
{
  "id": "text",
  "settings_id": "text",
  "module": "text",
  "min_bw_individual": 1,
  "min_bw_corporate": 1,
  "max_bw_corporate": 1,
  "reservation_expiry_period": 1,
  "organization": "text",
  "overprovisioning_factor": 1,
  "auto_reservation": true,
  "is_deleted": true
}
delete

API endpoint that allows users to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
204

No response body

No content
delete
DELETE /ux/common/telecom_settings/telecom_settings/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

Gets a list of telecom Settings

get

This endpoint is used to fetch all the telecom Settings in the current organization

Authorizations
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
200Success
application/json
get
GET /ux/common/telecom_settings/telecom_settings/get_settings/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "settings_id": "text",
  "module": "text",
  "min_bw_individual": 1,
  "min_bw_corporate": 1,
  "max_bw_corporate": 1,
  "reservation_expiry_period": 1,
  "organization": "text",
  "overprovisioning_factor": 1,
  "auto_reservation": true,
  "is_deleted": true
}
post

API endpoint that allows users to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
settings_idstringOptional
modulestringOptional
min_bw_individualnumber · floatOptional
min_bw_corporatenumber · floatOptional
max_bw_corporatenumber · floatOptional
reservation_expiry_periodnumber · floatOptional
organizationstringOptional
overprovisioning_factornumber · floatOptional
auto_reservationbooleanOptional
is_deletedbooleanOptional
Responses
200Success
application/json
post
POST /ux/common/telecom_settings/telecom_settings/update_settings/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "settings_id": "text",
  "module": "text",
  "min_bw_individual": 1,
  "min_bw_corporate": 1,
  "max_bw_corporate": 1,
  "reservation_expiry_period": 1,
  "organization": "text",
  "overprovisioning_factor": 1,
  "auto_reservation": true,
  "is_deleted": true
}
200Success
{
  "id": "text",
  "settings_id": "text",
  "module": "text",
  "min_bw_individual": 1,
  "min_bw_corporate": 1,
  "max_bw_corporate": 1,
  "reservation_expiry_period": 1,
  "organization": "text",
  "overprovisioning_factor": 1,
  "auto_reservation": true,
  "is_deleted": true
}
PreviousTeamsNextTrap Configurations