Public Data

Following API endpoints are used to administrate reference data of the system.

Get the list of suspension profiles

The following endpoint gives the list of existing suspension profiles together with their characteristics.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/suspension_profiles

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

Parameter	Type	Description	Required?
`size`	`integer`	Used for pagination, determines the maximum number of records on one page of results (defaults to 25)	no
`page`	`integer`	Used for pagination, determines the returned page from the collection of result pages (defaults to 1)	no

Response

Status codes

Parameter	Description
`200`	One or more suspension profile found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No suspension profile found
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`results`	`integer`	Total number of results from the query	no
`pages`	`integer`	Total number of pages according to pagination settings	no
`page`	`integer`	Current displayed page from the set of pages	no
`suspensionProfiles`	`array`	a list containing all suspension profiles in the system. See suspension profile for complete details	no

Example

json

{
  "results": 2,
  "pages": 1,
  "page": 1,
  "suspensionProfiles": [
    {
      "id": 2,
      "name": "suspended",
      "description": "Test Suspension Profile",
      "barringProfileId": "suspended_distributor"
    },
    {
      "id": 7,
      "name": "suspended_2",
      "barringProfileId": "Barred at Tenant level 2"
    }
  ]
}

Get the list of entitlement types

The following endpoint gives the list of existing license types together with their characteristics.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/entitlement_types

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

Note

Deprecated

This endpoint is deprecated. Use instead the equivalent endpoint with tenants/subscriptions structure.

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/entitlement_types

Authorization

Required role

tenants.instance.subscriptions.instance.entitlement_types.read

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`sub_id`	`integer`	Index of a subscription for which you want to get the MS Teams voice routing policy

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	One or more entitlement types found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`entitlement_types`	`array`	a list containing all the entitlement types in the system. See entitlement type for complete details	no

Example

json

{
    "entitlementTypes": [
        {
            "id": 1,
            "name": "Belgium - geographical numbers",
            "description": "",
            "externalReference": "",
            "createdOn": "2021-12-15T11:47:21",
            "updatedOn": "2021-12-15T11:47:21",
            "countryCode": "+32",
            "numberType": "geo",
            "serviceCapabilities": "*",
            "vanityType": null
        },
        {
            "id": 2,
            "name": "Belgium - tollfree numbers",
            "description": "",
            "externalReference": "",
            "createdOn": "2021-12-15T11:50:30",
            "updatedOn": "2021-12-15T11:50:30",
            "countryCode": "+32",
            "numberType": "tollfree",
            "serviceCapabilities": "*",
            "vanityType": null
        },
        {
            "id": 3,
            "name": "NL - geographic numbers",
            "description": "",
            "externalReference": "",
            "createdOn": "2021-12-15T11:51:03",
            "updatedOn": "2021-12-15T11:51:03",
            "countryCode": "+31",
            "numberType": "geo",
            "serviceCapabilities": "*",
            "vanityType": null
        },
        {
            "id": 4,
            "name": "test",
            "description": "test",
            "externalReference": "test",
            "createdOn": "2022-01-04T23:28:25",
            "updatedOn": "2022-01-04T23:28:25",
            "countryCode": "+93 00",
            "numberType": "*",
            "serviceCapabilities": "*",
            "vanityType": null
        }
    ],
    "pagination": [],
    "sorting": []
}

Get the list of country ISO codes

The following endpoint gives a list of country ISO codes.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/country_iso_codes

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	One or more country ISO code found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`countryIsoCodes`	`array`	a list containing all the country codes as known by the platform See country code for complete details	no

Example

json

{
    "countryIsoCodes": [
        {
            "isoCode": "AF",
            "name": "Afghanistan"
        },
        ...
        {
            "isoCode": "BE",
            "name": "Belgium"
        },
        ...
        {
            "isoCode": "FR",
            "name": "France"
        },
        ...
        {
            "isoCode": "IT",
            "name": "Italy"
        },
        ...
        {
            "isoCode": "GB",
            "name": "United Kingdom"
        },
        ...
        {
            "isoCode": "ZW",
            "name": "Zimbabwe"
        }
    ]
}

Get the list of country codes

The following endpoint gives a list of country codes (phone number country codes) as well as the associated country

Request

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/country_codes

Authorization

Required role

tenants.instance.subscriptions.instance.country_codes.read

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`sub_id`	`integer`	Index of a subscription for which you want to get the MS Teams voice routing policy

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	One or more country code types found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`countryCodes`	`array`	a list containing all the country codes as known by the platform See country code for complete details	no

Example

json

{
    "countryCodes": [
        {
            "id": 4,
            "code": "+1 (684) 011",
            "name": "American Samoa",
            "createdOn": "2021-09-20T14:30:49",
            "updatedOn": "2021-09-20T14:30:49"
        },
        {
            "id": 5,
            "code": "+376",
            "name": "Andorra",
            "createdOn": "2021-09-20T14:30:49",
            "updatedOn": "2021-09-20T14:30:49"
        }
    ]
}

Get the list of geographical regions

The following endpoint gives a list of geographical regions.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/geo_regions

Authorization

Required role

tenants.instance.subscriptions.instance.geo_regions.read

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`sub_id`	`integer`	Index of a subscription for which you want to get the MS Teams voice routing policy

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	One or more country code types found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`regions`	`array`	a list containing all the geographical regions as known by the platform See country code for complete details	no

Example

json

{
    "regions": [
        {
            "id": 1,
            "name": "Leuven",
            "createdOn": "2022-01-03T01:57:15",
            "updatedOn": "2022-01-03T01:57:15"
        },
        {
            "id": 2,
            "name": "Brussel",
            "createdOn": "2022-01-03T01:57:22",
            "updatedOn": "2022-01-03T01:57:22"
        },
        {
            "id": 3,
            "name": "Hasselt",
            "createdOn": "2022-01-03T01:57:31",
            "updatedOn": "2022-01-03T01:57:31"
        },
        {
            "id": 4,
            "name": "Borgloon",
            "createdOn": "2022-01-03T01:57:37",
            "updatedOn": "2022-01-03T01:57:37"
        },
        {
            "id": 5,
            "name": "Utrecht",
            "createdOn": "2022-01-03T01:59:52",
            "updatedOn": "2022-01-03T01:59:52"
        }
    ]
}

Get the list of postal codes

The following endpoint gives a list of available postal codes for entering an address.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/postal_codes

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

Note

Deprecated

This endpoint is deprecated. Use instead the equivalent endpoint with tenants/subscriptions structure.

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/postal_codes

Authorization

Required role

tenants.instance.subscriptions.instance.postal_codes.read

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`sub_id`	`integer`	Index of a subscription for which you want to get the MS Teams voice routing policy

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	One or more postal codes found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`postalCodes`	`array`	a list containing all postal codes as known by the platform. See postal code for complete details	no

Example

json

{
    "postalCodes": [
        {
            "id": 2014,
            "code": "3925BH",
            "city": "Scherpenzeel",
            "state": "Drenthe",
            "region": {
                "id": 122,
                "name": "Wolvega"
            },
            "country": {
                "id": 155,
                "name": "Netherlands"
            }
        },
        {
            "id": 2015,
            "code": "1300AE",
            "city": "Almere",
            "state": "Flevoland",
            "region": {
                "id": 70,
                "name": "Almere"
            },
            "country": {
                "id": 155,
                "name": "Netherlands",
                "isoCode": "NL"
            }
        }
    ]
}

Get the list of dial plan group

The following endpoint gives a list of dial plan groups.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/dial_plan_groups

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	One or more country code types found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`results`	`string`	Total count of results that match your query	no
`pages`	`string`	Total count of result pages that are available	no
`page`	`string`	ID of the page that is currently returned	no
`dialPlanGroups`	`array`	a list containing all the dial plan groups.

Example

json

{
    "results": 4,
    "pages": 1,
    "page": 1,
    "dialPlanGroups": [
        {
            "id": 1,
            "name": "Afghanistan"
        },
        {
            "id": 2,
            "name": "Afghanistan Mobile"
        },
        {
            "id": 3,
            "name": "Albania"
        },
        {
            "id": 4,
            "name": "Albania Mobile"
        }
    ]
}

Get the list of possible owners

The following endpoint returns the list of possible owners when creating a group, distributor, reseller or tenant. The API logic checks current user level and compares it against the level of the object to be created. It then returns a list of possible owners if any that may be used to link the to be created distributor, reseller or tenant to.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/owners

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

Parameter	Type	Description	Required?
`level`	`integer`	Level of the to be created object. Possible values are: `group`, `distributor`, `reseller`, `tenant`.	no

Response

Status codes

Parameter	Description
`200`	Returns no level if logic doesn't allow to choose one or a list of possible levels and identities for the owner
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`owners`	`array`	A list containing all possible owners for the object to be created	no

Owner Object

Parameter	Type	Description	Conditional?
`id`	`integer`	Internal ID of the possible owner in the database	yes
`name`	`string`	Name of the possible owner	yes
`uuid`	`string`	Universal unique id uniquely identifying the possible owner	yes
`type`	`string`	Level of the possible owner. Possible values are: `system`, `distributor`, `reseller`, `tenant`.	no

Example

json

{
    "owners": [
        {
            "id": 47,
            "name": "Netaxis Test Group",
            "type": "group",
            "uuid": "96b6bae5-d6af-4ead-b1a2-ac407eaf643e"
        },
        {
            "id": 387,
            "name": "Netaxis Test Distributor",
            "type": "distributor",
            "uuid": "9c201f22-044b-4c21-9727-5634d186c51a"
        },
        {
            "id": 213,
            "name": "Netaxis Test Reseller",
            "type": "reseller",
            "uuid": "29115105-ea54-4fe4-9061-b65b353c4cb2"
        }
    ]
}

Get all number ranges known in the NIMS

This endpoint returns all number ranges available in the number inventory from which the users can choose

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/number_inventory/ranges

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

Note

Deprecated

This endpoint is deprecated. Use instead the equivalent endpoint with tenants/subscriptions structure.

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/number_inventory/ranges

Authorization

Required role

tenants.instance.subscriptions.instance.number_inventory.ranges.read

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`sub_id`	`integer`	Index of a subscription for which you want to get the MS Teams voice routing policy

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	One or more entitlement types found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`ranges`	`array`	a list containing all the ranges in the number inventory. Per range an indication is provided about the amount of numbers still available within this range. See range for complete details	no

Example

json

{
    "ranges": [
        {
            "id": 1,
            "countryCode": "+32",
            "rangeStart": 16470000,
            "rangeEnd": 16479999,
            "numberType": "geo",
            "region": 1,
            "createdOn": "2022-01-03T01:58:12",
            "updatedOn": "2022-01-03T01:58:12",
            "nbAvailable": 10000,
            "nbTotal": 10000
        },
        {
            "id": 2,
            "countryCode": "+32",
            "rangeStart": 25400000,
            "rangeEnd": 25409999,
            "numberType": "geo",
            "region": 2,
            "createdOn": "2022-01-03T01:59:11",
            "updatedOn": "2022-01-03T01:59:11",
            "nbAvailable": 9990,
            "nbTotal": 10000
        },
        {
            "id": 3,
            "countryCode": "+31",
            "rangeStart": 302860000,
            "rangeEnd": 302869999,
            "numberType": "geo",
            "region": 5,
            "createdOn": "2022-01-03T02:00:21",
            "updatedOn": "2022-01-03T02:00:21",
            "nbAvailable": 10000,
            "nbTotal": 10000
        }
    ]
}

Get a number suggestion from the NIMS

Use this API to get 1 or more suggestions for available numbers/ranges. The numbers can then be assigned to a subscription

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/number_inventory/suggestion

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

Note

Deprecated

This endpoint is deprecated. Use instead the equivalent endpoint with tenants/subscriptions structure.

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/number_inventory/suggestions

Authorization

Required role

tenants.instance.subscriptions.instance.number_inventory.suggestion.read

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`sub_id`	`integer`	Index of a subscription for which you want to get the MS Teams voice routing policy

URL/Query parameters

Parameter	Type	Description	Required?
`numberType`	`string`	Number type of the numbers to be proposed	yes
`countryCode`	`string`	Country code of the numbers to be proposed	yes
`rangeId`	`integer`	Unique identifier of the range to be filtered.	no
`rangeSize`	`string`	Size of the range that has to be proposes. Must be > 0.	yes
`startsWith`	`string`	Use this parameter to get only numbers in specific ranges. The proposed numbers will start with this digit string	no
`numberOfResults`	`integer`	Amount of proposals you want to receive. Defaults to 1	no

Best effort

The API tries to comply as much as possible to your request but it might be possible that you request 10 suggestions but only 5 could be found. The API will not return an error but just provide 5 options.

WARNING

If you search in specific ranges, makes sure they stil have available ranges. Otherwise the API will not be able to provide suggestions.

Response

Status codes

Parameter	Description
`200`	One or more suggestions found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`suggestions`	`array`	a list containing range suggestions	no

Example

json

{
    "suggestions": [
        [
            25409983,
            25409992
        ],
        [
            25405300,
            25405309
        ],
        [
            25405340,
            25405349
        ],
        [
            25405450,
            25405459
        ],
        [
            25405380,
            25405389
        ],
        [
            25405390,
            25405399
        ],
        [
            25405310,
            25405319
        ],
        [
            25405260,
            25405269
        ],
        [
            25405430,
            25405439
        ],
        [
            25405270,
            25405279
        ]
    ]
}

Get the list of operators for number portability

The following endpoint returns the list of defined operators that may be used when creating a porting request.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/porting/operators

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	Returns a list of operators for a porting request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`operators`	`array`	A list containing all defined operators for a porting request	no

Operator Object

Parameter	Type	Description	Conditional?
`id`	`integer`	Internal ID of the operator in the NPACT database	no
`shortName`	`string`	Short name of the operator	no
`name`	`string`	Name of the operator	no
`contactEmail`	`string`	Contact Email of the operator	no
`default`	`boolean`	Indicates if the operator is the default one (there might be only one defined `true`)	no

Example

json

{
  "operators": [
    {
      "id": 1,
      "shortName": "WECO",
      "name": "WECO",
      "contactEmail": "",
      "default": true
    },
    {
      "id": 2,
      "shortName": "T108",
      "name": "T108",
      "contactEmail": "",
      "default": false
    }
  ]
}

Get the list of required document types when initiating a porting request

The following endpoint returns the list of required document types that need to be provided when creating a porting request.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/porting/documents

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	Returns a list of required document types when creating a porting request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`documents`	`array`	A list containing all required document types when iniaiting a porting request	no

Document Type Object

Parameter	Type	Description	Conditional?
`key`	`string`	A unique key defining the document type identity	no
`name`	`string`	Name of the document type	no
`description`	`string`	Description of the document type	no
`allowedFormats`	`array`	A list of MIME types allowed for the document type	no

Example

json

{
  "documents": [
    {
      "key": "id",
      "name": "ID",
      "description": "A copy of your national ID",
      "allowed_formats": [
        "image/jpg",
        "image/png",
        "image/bmp",
        "application/pdf",
        "application/msword",
        "application/vnd.oasis.opendocument.text"
      ]
    },
    {
      "key": "loa",
      "name": "Letter",
      "description": "Letter of authorization with the official company's letterhead; this is a letter telling you want to port in numbers you have added previously",
      "allowed_formats": [
        "image/jpg",
        "image/png",
        "image/bmp",
        "application/pdf",
        "application/msword",
        "application/vnd.oasis.opendocument.text"
      ]
    },
    {
      "key": "bill",
      "name": "Billing statement",
      "description": "Last (and up to date) billing statement showing that the company owns those numbers",
      "allowed_formats": [
        "image/jpg",
        "image/png",
        "image/bmp",
        "application/pdf",
        "application/msword",
        "application/vnd.oasis.opendocument.text"
      ]
    }
  ]
}

Get powershell information

The following endpoint returns information about current version of the powershell environment and major loaded modules.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/pwsh_info

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	Returns powershell and modules information
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`pwshInfo`	`object`	Information about the running powershell environment	no
`azureADInfo`	`object`	Information about the loaded Azure AD module	no
`azInfo`	`object`	Information about the loaded Az module	no
`msTeamsInfo`	`object`	Information about the loaded MS Teams module	no

Example

json

{
    "pwshInfo": {
        "psVersion": "7.2.0",
        "psEdition": "Core",
        "gitCommitId": "7.2.0",
        "os": "Linux 5.4.17-2136.301.1.2.el7uek.x86_64 #2 SMP Fri Nov 19 15:20:51 PST 2021",
        "platform": "Unix",
        "psRemotingProtocolVersion": "2.3",
        "serializationVersion": "1.1.0.1",
        "wsManStackVersion": "3.0"
    },
    "azureADInfo": {
        "version": "0.1.599.7"
    },
    "azInfo": {
        "version": "7.0.0"
    },
    "msTeamsInfo": {
        "version": "3.0.0"
    }
}

Get trunking POPs

POP stands for point of presence. A trunking POP is a point in our network, bound to a geographical location, to which you can connect your SIP trunks. In general you will connect your trunk to multiple POPs. This endpoint provides all potential connection points.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/public/trunking_pops

Authorization

Required role

Available for all authenticated users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	Returns powershell and modules information
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`pops`	`array`	A list containing all trunking pops that can be used to connect your SIP trunks	no

Trunking POPs Object

Parameter	Type	Description	Conditional?
`id`	`integer`	Unique ID uniquely representing the trunking POP	no
`name`	`string`	Friendly name of the POP type	no
`accessFQDN`	`string`	FQDN that has to be used as outbound proxy by the PBX	no
`accessPort`	`integer`	UDP port at which our network is expecting the trafic. Typically 5060.	no

Example

json

{
    "pops": [
        {
            "accessFQDN": "eindhoven.trunking.copaco.nl,",
            "accessPort": "5060",
            "id": 1,
            "name": "Trunking Access Eindhoven"
        },
        {
            "accessFQDN": "amsterdam.trunking.copaco.nl,",
            "accessPort": "5060",
            "id": 2,
            "name": "Trunking Access Amsterdam"
        }
    ]
}

Get the public configurations branding general

List of the public configurations of branding general.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/configurations/branding/general

Authorization

Required role

Available for all users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through all searchable configurations keys of a group that look like the string passed	no
`url`	`string`	The domain of the FUSION instance	yes

Response

Status codes

Parameter	Description
`200`	Properties has been correctly returned
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No group found
`500`	Uncatched error on server side

Success

Body

A dictionary defining properties as key / value pairs.

Example

json

{
    "apiVersion": "api/v01",
    "appTitle": "Fusion",
    "authentication": {
        "customLogOut": {
            "enabled": false,
            "route": "/forgot-password"
        },
        "emailID": "en",
        "keepUserLoggedIn": true
    },
    "backendUrl": "https://apio-dev.fusion.netaxis.cloud",
    "customTranslations": false,
    "draasInstance": "draas/draas_fusion_dev",
    "guideLink": "https://fusion.docs.netaxis.solutions/guides/onboarding/",
    "languages": [
        "en",
        "de",
        "fr"
    ],
    "modes": {
        "admin": {
            "sso": [
                {
                    "enabled": true,
                    "icon": "/branding/default/img/GoogleLogo.svg",
                    "mode": "oidc",
                    "name": "Google",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                },
                {
                    "enabled": true,
                    "icon": "/branding/default/img/Office365Logo.svg",
                    "mode": "oidc",
                    "name": "Office 365",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                },
                {
                    "enabled": false,
                    "icon": "/branding/default/img/ExponentialELogo.svg",
                    "mode": "oidc",
                    "name": "Exponential-e",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                }
            ]
        }
    },
    "msTeamInterval": 15000,
    "name": "DRaaS"
}

Get the public configurations branding pages

List of the public configurations of branding pages.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/configurations/branding/pages

Authorization

Required role

Available for all users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through all searchable configurations keys of a group that look like the string passed	no
`url`	`string`	The domain of the FUSION instance	yes

Response

Status codes

Parameter	Description
`200`	Properties has been correctly returned
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No group found
`500`	Uncatched error on server side

Success

Body

A dictionary defining properties as key / value pairs.

Example

json

{
    "distributor": {
        "distributorAdmins": {
            "enabled": true
        },
        "distributorLicenseConsumption": {
            "enabled": false
        },
        "distributorProfile": {
            "enabled": false
        },
        "distributorRatePlan": {
            "enabled": true
        },
        "distributorResellers": {
            "enabled": true
        },
        "distributorTenants": {
            "enabled": true
        }
    },
    "group": {
        "groupAdmins": {
            "enabled": true
        },
        "groupDistributors": {
            "enabled": true
        },
        "groupOrders": {
            "enabled": true
        },
        "groupProducts": {
            "enabled": true
        },
        "groupRatePlan": {
            "enabled": true
        },
        "groupResellers": {
            "enabled": true
        },
        "groupSettings": {
            "enabled": true
        },
        "groupTenants": {
            "enabled": true
        }
    },
    "groupSettings": {
        "groupSettingsConfiguration": {
            "enabled": true
        },
        "groupSettingsVoiceRouting": {
            "enabled": true
        }
    },
    "reseller": {
        "resellerAdmins": {
            "enabled": true
        },
        "resellerLicenseConsumption": {
            "enabled": false
        },
        "resellerProfile": {
            "enabled": false
        },
        "resellerRatePlan": {
            "enabled": true
        },
        "resellerTenants": {
            "enabled": true
        }
    },
    "subscription": {
        "subscriptionNumbers": {
            "tabs": {
                "myNumbers": {
                    "enabled": true
                },
                "porting": {
                    "enabled": true
                },
                "releasedNumbers": {
                    "enabled": true
                },
                "reservedNumbers": {
                    "enabled": true
                }
            }
        }
    },
    "system": {
        "systemGroupSettings": {
            "enabled": true
        },
        "systemGroups": {
            "enabled": true
        }
    },
    "tenant": {
        "tenantAdmins": {
            "enabled": true
        },
        "tenantOrders": {
            "enabled": true
        },
        "tenantProfile": {
            "enabled": true
        },
        "tenantRatePlan": {
            "enabled": true
        },
        "tenantSubscriptions": {
            "enabled": true
        }
    }
}

Get the public configurations branding styling

List of the public configurations of branding styling.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/configurations/branding/styling

Authorization

Required role

Available for all users

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through all searchable configurations keys of a group that look like the string passed	no
`type`	`string`	The type of styling asset. Possible values are: `font`, `image`, `theme`.	yes
`url`	`string`	The domain of the FUSION instance	yes

Response

Status codes

Parameter	Description
`200`	Properties has been correctly returned
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No group found
`500`	Uncatched error on server side

Success

Body

A dictionary defining properties as key / value pairs.

Example type=font

json

{
    "allowed": [
        "blue",
        "red",
        "green"
    ],
    "name": "Avenir Next Cyr"
}

Example type=image

json

{
    "favicon": "/branding/default/favicon/favicon.ico",
    "login": {
        "bg": "/branding/default/img/Loginbackground.png",
        "logo": "/branding/default/img/LoginLogo.svg"
    },
    "main": {
        "bg": "/branding/default/img/MainBackground.png",
        "logo": "/branding/default/img/Logo.svg"
    }
}

Example type=theme

json

{
    "allowed": [
        "blue",
        "red",
        "green"
    ],
    "selected": "blue",
    "themes": {
        "blue": "/branding/default/theme.blue.json",
        "green": "/branding/default/theme.green.json",
        "red": "/branding/default/theme.red.json"
    }
}

Public Data ​

Get the list of suspension profiles ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Get the list of entitlement types ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

Note ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Get the list of country ISO codes ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Get the list of country codes ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Get the list of geographical regions ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Get the list of postal codes ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

Note ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Get the list of dial plan group ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

Public Data

Get the list of suspension profiles

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Get the list of entitlement types

Request

Endpoint

Authorization

Path Parameters

Note

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Get the list of country ISO codes

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Get the list of country codes

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Get the list of geographical regions

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Get the list of postal codes

Request

Endpoint

Authorization

Path Parameters

Note

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Get the list of dial plan group

Request

Endpoint

Authorization

Path Parameters