Common Objects¶

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

System network class of service in list attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	The name of the network class of service.
description	String	A	The description of the network class of service.

System network class of service attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
description	String	O	The description of the network class of service.
communicationBarringProfiles	Array	O	List of objects CommunicationBarringProfile object attributes.
networkTranslationIndex	String	O	The name of a Translation and Routing rule
callProcessingPolicyProfileName	String	O	The Call Processing Policy Profile, the list of profiles is comong from TODO API

CommunicationBarringProfile object attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	The name of the communication barring profile.
isPrimary	Boolean	A	If true, this is the active profile. There can be only one primary profile within a NCOS.
profileId	Integer	A	The profile Id of the communication barring profile.

License object attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	The name of the license.
licensed	String	A	The max number of licenses that can be assigned.
used	String	A	The number of licenses used.
available	String	A	The number of licenses available.

License user service object attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	The name of the license.
licensed	String	A	The max number of licenses that can be assigned.
used	String	A	The number of licenses used.
available	String	A	The number of licenses available.
usedByHostedUsers	String	A	The number of licenses used by hosted users.
usedByTrunkUsers	String	A	The number of licenses used by trunk users.
expirationDate	String	A	The expiration date of the license.

Call Type attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
callTypeName	String	A	Virtual On-Net Call Type Name.
callTypeCDR	String	A	Virtual On-Net Call Type CDR Value.

Time Zone attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	Time zone name in the format <Country>/<City> (this should be the format to be used to assign a time zone to a group).
description	String	A	Time zone extended description.

Call Recording Platform attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	The Call Recording Platform name.
netAddress	String	A	The Call Recording Platform net address. IP Address, hostname, or domain.
port	Integer	C	The Call Recording Platform port.
mediaStream	String	A	Value comes from list: “Dual”, “Single”. Subscriber’s media is sent separately from the media generated by the called/calling parties when “Dual” is selected while “Single” is a single media stream that contains all media.
transportProtocol	String	A	The Call Recording Platform Network Transport Protocol. Value comes from list: “UDP”, “TCP”, “Unspecified”.
description	String	C	The Call Recording Platform description.
schemaVersion	String	A	Supported versions of the BroadWorks-specific extension metadata. Value comes from list: “1.0”, “2.0”, “3.0”.
supportVideoRecording	Boolean	A	Specifies if to enable the video recording support.

System rules apply to attribute¶

Could be one of ‘System, Provisioning Administrator’, ‘System, Provisioning, Service Provider Administrator’, ‘Administrator and User’.

treatments attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	name of treatment
description	String	A	description.