ListTenants
Provides the list of all tenants in the system with the following filters. All filters are optional, and if a filter is not provided, the query will use the defaults, which are sorting all the tenants by the tenant names in ascending order.
This method can use the following parameters.
Request parameters
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
tenantName |
String |
Specifies the tenant name |
No |
|
tenantURL |
String |
Specifies the tenant URL |
No |
|
filter.<nnnn> |
The filter type is used to trim down (filter) the search results. The value <nnnn> could be any of or all of the variables below. |
Yes |
|
|
start |
Integer |
This is the beginning index of the search result. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value. |
No |
|
limit |
Integer |
This is the number of results that are being requested. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value. |
No |
|
sortBy |
String memberID name Display name extension |
This is the field by which the requestor is asking the results to be sorted by. In the User API, entityID is used instead of memberID. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the sortBy=extension/name/displayName or memeberID value. |
No |
|
dir |
String ASC DESC |
This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the dir=ASC value. |
No |
Response parameters
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
listOfTenants: |
SingleTenantDataType |
Array of Object includes: |
|
|
tenantID |
Integer |
Specifies the tenant ID |
Yes |
|
tenantName |
String |
Specifies the tenant name |
Yes |
|
tenantURL |
String |
Specifies the tenant URL |
Yes |
|
extensionPrefix |
String |
Tenant extension prefix |
Yes |
|
dialinNumber |
Integer |
Tenant dial-in number |
Yes |
|
vidyoReplayUrl |
String |
Tenant's VidyoReplay URL |
Yes |
|
description |
String |
Description of the tenant |
Yes |
|
vidyoMobileAllowed |
Boolean |
Indicates whether access for VidyoMobile ('0' - no/false, '1' - yes/true) |
Yes |
Faults
|
Name |
Description |
|---|---|
|
GeneralFault |
An unspecified error occurred |
|
InvalidArgumentFault |
The arguments that were passed into services were wrong |
|
NotLicensedFault |
API is not licensed |