Common Objects

Several end points are using similar objects or methods at Tenant level. They are described in this section.

Group basic attributes

Name	Type	Method	Description
		GET
groupId	String	A	See groupId from Group attributes.
groupName	String	A	See groupName from Group attributes.
userLimit	Integer	A	See userLimit from Group attributes.
tenantId	String	A	The ID of the Tenant owning this Group.
resellerId	String	O	See resellerId from Group attributes.
backendName	String	C	The name of the Backend, only provided for a multi-as user, in a system search and if configured to return it.
backendExternalName	String	C	The external name of the Backend, same constraints as backendName.

Note

To get more details about a group see Group.

Service License Management List Item

Name	Type	Methods		Description
		GET	PUT
name	String	A	R	The name of the service to be authorized or unauthorized.
allocated	Object	A	R	Allocation counters. See Service License Allocation Counters.
currentlyAllocated	Integer	C	F	Amount of direct allocation for the selected service in the different groups of the tenant. Present if relevant.
packsAllocated	Integer	C	F	Amount of allocation through service packs for the selected service in the different groups of the tenant. Present if relevant.
status	String	C	F	Identifies the update operation status. Valued from “failed”, “updated”. Present if relevant after an update.
description	String	C	F	Description of the service. Present if relevant and provided by the Network Element.

Tenant Numbers attributes

Name	Type	Methods		Description
		GET	POST
numbers	Object | F | O			See numbers from Group Numbers attributes.
range	Object | F | O			See range from Group Numbers attributes.
result	Object	C	F	See result from Group Numbers attributes.
assignement_phoneNumbers	Array	C	F	List of objects Tenant Assigned Numbers attributes.
available_phoneNumbers	Array	C	F	List of the available phone numbers.

Tenant Assigned Numbers attributes

Name	Type	Method	Description
		GET
phoneNumbers	String	A	The phone number.
assignedToGroup	String	A	The group assigned to the phone number.
canBeDeleted	Boolean	A	Can be deleted status based on the group assignation.

Tenant Mobile Numbers attributes

Name	Type	Method		Description
		GET	POST
phoneNumbers	Object | F | O			See numbers from Group Numbers attributes.
result	Object | C | F			See result from Group Mobile Numbers attributes.
assigned_numbers	Array	C	F	See assignement_phoneNumbers from Tenant Numbers attributes.
available_numbers	Array	C	F	See available_phoneNumbers from Tenant Numbers attributes.

Contact Information attributes

Name	Type	Methods			Description
		GET	POST	PUT
name	String	A	O	O	The name of the person of contact.
phoneNumber	String	A	O	O	The phone number of the person of contact.
emailAddress	String	A	O	O	The email address of the person of contact

Contact Information attributes

Name	Type	Methods			Description
		GET	POST	PUT
addressLine1	String	A	O	O	The street, number, box address.
addressLine2	String	A	O	O	The continuation of the address if it must be presented over 2 lines.
city	String	A	O	O	The city.
state	String	A	O	O	The state or province or equivalent notion.
stateDisplayName	String	A	O	O	A display name for the state if needed.
postalCode	String	A	O	O	The postal or zip code.
country	String	A	O	O	The country.

Phone List attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
name	String	A	R	O	R	The name of the phone list entry.
phoneNumber	String	A	R	O	F	The phone number of the phone list entry.

Tenant network class of service in list attributes

Name	Type	Method	Description
		GET
name	String	A	The name of the network class of service.
description	String	A	The description of the network class of service.
default	Boolean	A	If true, this is the active network class of service.

Tenant virtual on net user in get list attributes

Name	Type	Method	Description
		GET
groupId	String	A	User’s group id.
lastName	String	A	User’s last name.
firstName	String	A	User’s first name.
phoneNumber	String	A	User’s phone number.
extension	String	A	User’s extension.
callType	String	A	Virtual On Net call type name.

Service User in List attributes

Name	Type	Method	Description
		GET
userId	String	A	The unique user Id.
groupId	String	A	The ID of the Group owning this User.
name	String	A	The user last name. (See First / Last name).
department	Object	C	The department the user belongs to. (See Group department key attributes).
extension	String	C	The user extension. (See Extension).
phoneNumber	String	C	The user phone number (See Phone Number).
serviceType	String	A	The user exact service type. (See Service Type).

Tenant meet me conferencing ports attributes

Name	Type	Methods		Description
		GET	PUT
unlimited	Boolean	A	O	If true, the number of allocated ports is unlimited. If false, quantity must be specified.
quantity	Integer	C	O	The limited number of allocated ports.

Tenant department in list attributes

Name	Type	Method	Description
		GET
tenantId	String	A	The ID of the Tenant which this department belongs.
departmentName	String	A	The name of the department.
parentDepartment	Object	C	The parent department.

Tenant department attributes

Name	Type	Methods			Description
		GET	POST	PUT
departmentName	String	N	R	O	The name of the department.
parentDepartment	Object	C	N	N	The parent department. In case of GET: an object as Tenant department available parent list attributes.
	String	N	O	O	The parent department. In case of PUT or POST: the department name of the parent.

Tenant department available parent list attributes

Name	Type	Method	Description
		GET
tenantId	String	A	The ID of the Tenant which this department belongs.
departmentName	String	A	The name of the department.
fullPathName	String	A	The full path name of the department, containing the name of the parent department.

Immediate Trunking Connectivity Numbers Range attributes

Name	Type	Methods			Description
		GET	POST	DELETE
minPhoneNumber	String	A	R	R	The min range phone number.
maxPhoneNumber	String	A	R	F	The max range phone number.
active	Boolean	A	F	F	Specify if the range is active or not.
extensionLength	String	C	F	F	Specify the length of the extension. Introduced with patch from rel 23.

Immediate Trunking Connectivity Prefixes attributes

Name	Type	Methods			Description
		GET	POST	DELETE
prefix	String	A	R	R	The prefix number.
active	Boolean	A	F	F	Specify if the range is active or not.
extensionRangeStart	String	C	F	F	Specify the starting range of the extension. Introduced with patch from rel 23.
extensionRangeEnd	String	C	F	F	Specify the ending range of the extension. Introduced with patch from rel 23.

Device in List attributes

Name	Type	Method	Description
		GET
groupId	String	C	The unique id of the group of this device. If the device is not at group level, the groupId is not returned.
deviceName	String	A	See deviceName from Access Device attributes.
deviceType	String	A	See deviceType from Access Device attributes.
netAddress	String	A	See netAddress from Access Device attributes.
macAddress	String	A	See macAddress from Access Device attributes.
status	String	A	See status from Access Device attributes.

Digit pattern criteria in list attributes

Name	Type	Method	Description
		GET
name	String	A	The unique name of the digit pattern criteria.
description	String	A	The description of the digit pattern criteria.

Digit pattern criteria attributes

Name	Type	Method			Description
		GET	POST	PUT
name	String	N	R	R	The unique name of the digit pattern criteria.
description	String	C	O	O	The description of the digit pattern criteria.
digit_patterns	Array	C	O	O	A list of digit patterns. The patterns can consist of the digits 0 through 9 and a leading + and the following wild cards: ? - a single-digit placeholder. For example, 555???? matches any string beginning with 555, plus at least four additional digits. [] - Indicates a range of digits. A consecutive range indicated with a hyphen (-), or a nonconsecutive range with a comma (,). Hyphens and commas can be used in combination ie [5-7,9]. Only single-digit ranges are supported. ie. [98-102] is invalid. In AS data mode: $ - Any number of digits. For example 555$ matches any digit string beginning with 555 plus zero or more additional digits. The $ card may be placed at the beginning or the end of the digit pattern, but not both. In XS data mode: * - Any number of digits. For example 555* matches any digit string beginning with 555 plus zroe or more additional digits.

Profile in list attributes

Name	Type	Method	Description
		GET
default	Boolean	A	Specifies if the profile is set as default.
name	String	A	The unique name of the profile.
description	String	A	The description of the profile.

Digit pattern rule attributes

Name	Type	Methods			Description
		GET	POST	PUT
criteria	String	C	C	O	A communication barring criteria name. Within the POST request it is mandatory to provide one between: “criteria” or “digitPatternCriteria”.
digitPatternCriteria	String	C	C	O	A digit pattern criteria name. Within the POST request it is mandatory to provide one between: “criteria” or “digitPatternCriteria”.
action	String	A	R	O	The rule action. If originating rule value comes from: “Allow”, “Allow Timed”, “Block”, “Authorization Code”, “Authorization Code Timed”, “Treatment”, “Transfer”. If any other rule value comes from: “Allow”, “Allow Timed”, “Block”.
treatmentId	String	C	C	C	Configurable treatment name. Only configurable, and mandatory, when the action selected is “Treatment”.
transferNumber	String	C	C	C	An outgoing phone number. Only configurable, and mandatory, when the action selected is “Transfer”.
callTimeoutSeconds	String	C	C	C	Timeout time in seconds. Only configurable when the action selected is one of “Allow Timed” or “Authorization Code Timed”.
timeSchedule	String	C	O	O	Configurable time schedule name.
holidaySchedule	String	C	O	O	Configurable holiday schedule name.

Digit pattern criteria attributes

Name	Type	Method			Description
		GET	POST	PUT
name	String	N	R	O	The unique name of the digit pattern criteria.
description	String	C	O	O	The description of the digit pattern criteria.
originatingDefaultAction	String	C	R	O	The default action in case of originating call.
originatingRules	Array	C	O	O	A list of digit patterns.
redirectingDefaultAction	String	C	R	O	The default action in case of redirecting call.
redirectingRules	Array	C	O	O	A list of digit patterns.
callMeNowDefaultAction	String	C	R	O	The default action in case of Call Me Now call.
callMeNowRules	Array	C	O	O	A list of digit patterns.
incomingDefaultAction	String	C	R	O	The default action in case of incoming call.
incomingRules	Array	C	O	O	A list of digit patterns.
default	Boolean	C	R	O	Is it the default digit pattern criteria.
applyToAttendedCallTransfers	Boolean	C	R	O	A list of digit patterns.

Tenant rules apply to attribute

Could be one of ‘Administrator’, ‘Administrator and User’, ‘Group Administrator and User External Authentication’.

Tenant Announcement attributes

Name	Type	Methods		Description
		GET	PUT
content	String	N	R	The media file content (encoded to base64 format) to be uploaded.
description	String	A	R	The media file description.

Feature Access Code

Name	Type	Method		Description
		GET	PUT
name	String	A	R	Feature Access Code Name
code	String	A	R	Feature Access Code
alternateCode	String	C	O	Alternative Feature Access Code. Use “” for reset code
enabled	Boolean	A	O	Specify if Feature Access Code is enabled or not

User’s Application Data List Item

Name	Type	Methods	Description
		GET
tenantId	String	A	The Tenant Id of the user owning the App Data.
groupId	String	A	The Group Id of the user owning the App Data.
userId	String	A	The User Id of the user owning the App Data.
applicationId	String	C	The Application Id.
key	String	C	The key inside the Application.
data	String	C	The data association to the application+key.