Read-only. AXL API automatically adds the required entries in the AARDialPrefixMatrix table. Valid range is 1-127 characters. Read Only.Credential configuration for password. Only the uuid attribute is read by the AXL API. Valid range is 1-42 characters. Only the uuid attribute is read by the AXL API. Read Only. Also known as controlled devices. Name of device. The User Groups to which the application user is associated with. Name of User Group Read Only. Name of the User Role associated with the user group. Read Only.The Certification Authority Proxy Function Profiles to which the application user is associated with. Abstraction of all devices in the Call Manager system. The device name, using only URL-friendly characters. Optional description of the device. Product/Model/Class block Product information is read-only except when creating a device. Product ID string. Complete product information block. Model information is read-only. Model ID string. Complete model information block. Class ID string. Class information is read-only except when creating a device. Protocol block Protocol information is read-only except when creating a device. Side information is read-only except when creating a device. Any device that makes calls has a calling search space. This tag is not valid for a device profile. Only the uuid attribute is read by the AXL API. Device Pools are required for most devices, including phones and gateways. Its not required for Device Profile. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by AXL API. Only applicable to Phone. Only the uuid attribute is read by AXL API. The new Device Destination flag for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways, except FXS gateways and phones. Not Nullable. All devices that receive calls implicitly have a location for bandwidth negotiation. If the location is not defined, it is assumed to be LOCAL. Only the uuid attribute is read by the AXL API. Media Resource (MOH) information. This tag is not valid for a device profile. Only the uuid attribute is read by the AXL API. This tag is not valid for H323Phone, H323Trunk and SIPTrunk. This tag is not valid for H323Phone, H323Trunk and SIPTrunk. This tag is not valid for a device profile. The calling search space used by Automated Alternate Routing. Nullable. Only the uuid attribute is read by the AXL API. The name of the calling search space used by Automated Alternate Routing. Nullable. This tag is not valid for a device profile. For IP Phones and Gateways. Nullable. Only the uuid attribute is read by the AXL API. For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product. UUID changed each time the device is updated. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This tag is valid only for phones, SIP trunks and voice mail ports. Not nullable. Only the uuid attribute is read by the AXL API. This tag is valid only for SIP Trunks and SIP Phones. Only the uuid attribute is read by the AXL API. Not Applicable for VoicemailPort, DeviceProfile, T1-CAS and FXO ports. Only the uuid attribute is read by the AXL API. Not Applicable for VoicemailPort, DeviceProfile, T1-CAS and FXO ports. Not applicable for Device Profiles Only the uuid attribute is read by the AXL API. Not applicable for Device Profiles, CTI Route Points, Phones, Voicemail, FXS ports Only the uuid attribute is read by the AXL API. Not applicable for Device Profiles, CTI Route Points, Phones, H323 devices, FXS, FXO, T1, PRI, BRI and VoiceMail Ports Computer Telephony Interface ID, Unique, Cannot be null. This is the entry to the DeviceNumPlanMap table. The directory number is referred to by the "dirn" or "dirnId" sub-element. An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element. The lineIdentifier is a shorthand method that refers to a particular direcotyr number. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Applicable for Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values range from 1 to 4.The value should be given as per the formula. Cisco Media Server : subunit = ((Extract two digits after 'A' from the name)-2)/3 + 1. Cisco Conference Bridge: subunit = ((Extract two digits after 'C' from the name)-1)/3 + 1 This tag is used only by Cisco Conference Bridge Hardware.For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product. This tag is used only by Cisco Video Conference Bridge(IPVC-35xx),Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). This tag is used only by Cisco Conference Bridge(WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values for this tag are 32,64,96,128. Valid only for Cisco IOS Enhanced Conference Bridge Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. This is an abstract base type for all Gateways to extend. Only the uuid attribute is read by the AXL API. Supported only by a few MGCP gateways like 26XX, 366X, 37XX, 269X, 38XX, VG224. Applicable only for DigitalAccess PRI Gateways Analog Gateways extend Device and are concrete types. The gateway's country code. Nullable. The maximum number of ports this gateway supports. Read-only. The list of ports on the gateway. Describes the trunk-selection order for this gateway (ie, bottom-up, top-down). Read-only. Applicable to PRI gateways.For analog and T1 gateways, this tag comes under ports. Does not apply to PRI gateways. Additional modules attached to the phone. There can be 0, 1, or 2. Only the uuid attribute is read by the AXL API. Read-only for IP Phones. The Extension Mobility block. By default, extension mobility is disabled. To enable, include a default profile and set enableExtensionMobility to true. Only applicable to 7960 and 7940 phones. If enableExtensionMobility is false then these elements will not appear. The absence of this tag would mean the device would use the current device Settings Only the "uuid" attribute is applicable to the AXL API. Not nullable. The name of the default profile for this device. Not nullable. Not nullable. The current user profile in use by this device. Read-only. Read-only. Read-only. Read-only. Read-only. This tag is valid only for a getPhoneResponse. It contains Extension Mobility related parameters for a device when a user is logged in using a user defined device profile. If no user is logged in, the original device information for these parameters is returned Only the uuid attribute is read by the AXL API. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. Only the uuid attribute is read by the AXL API. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. This tag is valid only for devices that support SBB. This tag is valid only for devices that support JAL. This tag is valid only for devices that support SBB. This tag is valid only for devices that support JAL. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. This tag is not valid for a device profile. Only the uuid attribute is read by the AXL API. This tag is not valid for a device profile. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. These tags can be updated only if securityProfile is not mentioned in the request. authenticationMode can be updated only if certificateOperation field is Install/Upgrade, Delete or Troubleshoot. keySize can be updated only if certificateOperation field is Install/Upgrade, Delete or Troubleshoot. authenticationString can be updated only if certificateOperation field is Install/Upgrade, Delete or Troubleshoot. Read-only tag. Specifies if the phone is configured for device mobility feature or not Read-only. Specifies the device pool being used if the device is roaming and the devicemobility feature is enabled for it. This tag is valid only for devices that support DND. This tag is valid only for devices that support DND. This tag is valid only for devices that support DND. This tag determines if the newly added phone is active to determine consumption of license. If set to false the license units will not be consumed. Read-only tag. Applicable only for dual mode phones. The GUID of the mobility User for this phone. Nullable. The userid of the mobility user for this phone. Nullable. If a blank tag is passed, the value of "Default" is inserted into the database. This tag is valid only for devices that support Secure Tone This tag is valid only for CUMC devices. Only the uuid attribute is read by the AXL API. This field is applicable only to SIP phones. This field is applicable only to SIP phones. This field is applicable only to SIP phones. Only the uuid attribute is read by the AXL API. This tag is applicable only to those devices that support ssh feature. This tag is applicable only to those devices that support ssh feature. This field is applicable only to SIP phones. This field is applicable to only those phones that support Automatic Outbound Call Rollover. Features associated with this BLFSpeedDial button Name of the feature. Only the UUID attribute is read by AXL API. Abstract representation of a phone device. This field has been deprecated in Seadragon When adding or updating a phone with the AXL API, only use the 'line' element. Do not use when adding or updating a phone. Do not use when adding or updating a phone. Do not use when adding or updating a phone. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. This field has been deprecated in Seadragon The value of numDigits must be either 0 to 32 or 99. This tag enables the significant digits for the gateway; if the tag is set to true, the value of the 'numDigits' element is used as Significant Digits for the gateway. This tag should have a value of false if numDigits is set to 99. The value of numDigits must be either 0 to 32 or 99. This tag enables the significant digits for the gateway; if the tag is set to true, the value of the 'numDigits' element is used as Significant Digits for the gateway. This tag should have a value of false if numDigits is set to 99. Read-only. Applicable for only if PRI variant is QSIG Applicable for only if PRI variant is QSIG Server devices are server processes that receive and/or make calls; because they are server-based, they have a process node. Read-only. Read-only. Applicable only for H323Gateways/Trunks Only the uuid attribute is read by the AXL API. Applicable only for H323Gateways/Trunks Applicable only for H323Phones and H323Trunks.Not for H323Gateways. Only the uuid attribute is read by the AXL API. Applicable only for H323 Phones. If set to True, mediaResourceList must be mentioned and mtpRequired must be set to True. enableOutboundFaststart must be set to true for it to be read. Not Nillable. Only the uuid attribute is read by the AXL API. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. Applicable for only if PRI variant is QSIG Applicable for only PRI variant is QSIG Applicable only for H323Gateways/Trunks Applicable only for H323Gateways/Trunks Applicable only for H323Gateways/Trunks Applicable only for H323Gateways/Trunks The value of significantDigits must be either from 0 to 32 or 99. Here 99 means All. enable attribute is Read-Only. If significantDigits is 0-32 then enable is true, if significantDigits is 99 then enable is false. The tag will not be applicable for any type of Inter-Cluster trunk Only the uuid attribute is read by the AXL API. Applicable only for Non-Gatekeeper controlled ICT trunk's. Should be set only when ictPassingPrecedenceLevelThroughUUIE is set to true. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Valid characters for Destination Address are letters, numbers, dashes and dots(periods). IP address should have four 8-bit numbers seperated by periods. Host name should start with letter and end with letter or number. This tag is ignored and destAddrIsSRV is set to false if destinationaddress is an IP address and destinationport is mentioned correctly. This tag depends on destAddrIsSRV. It is mandatory when destAddrIsSRV is false or when destination address is an IP address. Valid values between 1024 to 65535 (inclusive) The ampersand is a reserved character in xml. It can be escaped as "&" The value of sigDigits must be either from 0 to 32 or 99. Here 99 means All. enable attribute is Read-Only. If sigDigits is 0-32 then enable is true, if sigDigits is 99 then enable is false. Characters which are not valid for caller name are ampersand, braces, less than or greater than, percentage sign, double quotes, square brackets and pipe. This tag is valid only if srtpAllowed is set to false. Only the uuid attribute is read by the AXL API. Gatekeeper is a type of device. From device table. From device table. Registration Request Time to Live. Registration Retry Timeout The device name, using only URL-friendly characters. Optional description of the device. Product/Model/Class block Product information is read-only except when creating a device. Product ID string. Complete product information block. Model information is read-only. Model ID string. Complete model information block. Class ID string. Class information is read-only except when creating a device. Protocol block Protocol information is read-only except when creating a device. Side information is read-only except when creating a device. Any device that makes calls has a calling search space. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. When adding or updating a remoteDestinationProfile with the AXL API, only use the 'line' element. Do not use when adding or updating a remoteDestinationProfile. Do not use when adding or updating a remoteDestinationProfile. Do not use when adding or updating a remoteDestinationProfile. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. This tag is valid only for devices that support DND. This tag is valid only for devices that support DND. Only the uuid attribute is read by the AXL API. An Automated Alternate Routing Neighborhood. Sidecar modules for used by Cisco IP Phones. Load Information is either the module's specific load information or the default load information.If any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product. Model ID string. List of analog ports on an analog gateway. An analog port on an analog gateway. The portNumber attribute identifies the ordinal value of the port in the gateway. The value for finalDigits must be between 0 to 32. Ignore the significant attribute, it has been depricated and kept only for backward compatibility issue. When adding or updating with the AXL API, do not use the lineId element. Not used by T1 Ports. Arbitrary XML defined by 3rd party vendors. A button on a phone template. The feature invoked by this button. The label to display for this button. DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting. Only the uuid attribute is read by the AXL API. This tag is applicable only for callForwardAll. Only the uuid attribute is read by the AXL API. Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting Use original Called DN forward no-coverage settings Only the uuid attribute is read by the AXL API. Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s. Read-only. Read-only. Only the uuid attribute is read by the AXL API. DEPRECATED: use routePartition/uuid Read-only. name is now autogenerated. Only the uuid attribute is read by the AXL API. UDP port for MGCP communication. TCP port for backhaul for Q.931 messages. Only the uuid attribute is read by the AXL API. Only use when setting TFTP Default to true. Setting to true will result in setting all other CallManager groups to false. Only the uuid attribute of callManager is read by the AXL API. Only the uuid attribute is read by the AXL API. If this tag is set to true, zero is inserted into the database for failedLogon. Failed logon must be a number in the range 0 to 100. Reset Failed logon attempts must be a number in the range 1 to 120. If this tag is set to true, zero is inserted into the database for lockoutDuration. Lockout duration must be a number in the range 0 to 1440. Credential change duration must be a number in the range 0 to 129600. If this tag is set to true, zero is inserted into the database for credExpiresAfter. Credential expires after must be a number in the range 0 to 365. Minimum credential length must be a number in the range 0 to 64. Stored number of previous credentials must be a number in the range 0 to 25. Inactive days allowed must be a number in the range 0 to 5000. Expiry warning days must be a number in the range 0 to 90. Not nullable. Only the uuid attribute is read by the AXL API. Nullable. Only the uuid attribute is read by the AXL API. Not Nullable. Only the uuid attribute is read by the AXL API. Not nullable. uuid will be returned in get Response. Only the uuid attribute is read by the AXL API. Nullable. Only the uuid attribute is read by the AXL API. Nullable. Nullable. The value accepted and retrieved from the database for this field will be of type XCountry in AXLEnums.xsd -1 means using system default The calling search space used by Automated Alternate Routing. Nullable. Only the uuid attribute is read by the AXL API name of the calling search space used by Automated Alternate Routing. Nullable. For IP Phones and Gateways. Nullable. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API The calling search space used by Device Mobility. Nullable. Only the uuid attribute is read by the AXL API The name of the calling search space used by Device Mobility. Nullable. Only the uuid attribute is read by the AXL API the uuid attribute is read by the AXL API The value accepted and retrieved from the database for this field will be of type XRevertPriority in AXLEnums.xsd. Only the uuid attribute is read by the AXL API Only the uuid attribute is read by the AXL API Only the uuid attribute is read by the AXL API Only uuid attribute is read by the AXL API Only uuid attribute is read by the AXL API only the uuid attribute is read by the AXL API. Nullable Nullable. The value accepted and retrieved from the database for this field will be of type XUserLocale in AXLEnums.xsd. Nullable Nullable This setting only affect devices that support MLPP This setting only affect devices that support MLPP Default is not applicable for CommonDeviceConfig API This setting only affect devices that support MLPP Only the uuid attribute is read by AXL API. The valid values ranges from 0 to 1073741824. The valid values ranges from 0 to 1073741824. The valid values ranges from 0 to 1073741824. The valid values ranges from 0 to 1073741824. Each DHCPSubnet is associated with a unique DHCP Server. only the uuid attribute is read by the AXL API. Value between 0 to 1073741824. Value between 0 to 1073741824. Value between 0 to 1073741824. Value between 0 to 1073741824. Actually called "tag" in database. Only the uuid attribute is read by the AXL API. Read-only. Only the uuid attribute is read by the AXL API. The URI of this instance. For example: xmldi://cisco.com/Cisco VG200/mgcp At this point, you will either see a uses element optional followed by a parameters block, or simply a parameters block. Name of the display instance this display instance extends or includes. The tag that appears in the actual vendor configuration block stored in the database. The pattern enforces that the name is only made up of letters, digits, dashes, periods, or underscores. If displayName is set, the UI should show it instead of the NAME to the user. UI directive. This parameter should not be shown in the UI. Index is translated into an index attribute in the parameter expressed in a vendor config. Really only useful for parameters contained within paramGroups. UI directive. The parameter is entirely read-only. Whatever value is current assigned to the parameter is never changed in the UI. UI directive. Text to always display in the UI. UI directive. The parameter is really just a heading for a paramGroup. The rules to validate this parameter against. The URI of the rule to validate this parameter against; for example: xmlrule://cisco.com/public/isAnInteger The only valid values for enableUPS are true, True, false and False. The only valid values for enableUPC are true, True, false and False. Table: A Line Appearnce (defined from DeviceNumPlanMap). Only the uuid attribute is read by the AXL API. Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Applicable only for IP Phones. Applicable only for IP Phones. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. This tag cannot be modified. It can only be specified in the add request. Indicates the cardinality of the line. Refer to DeviceNumPlanMap.NumPlanIndex. Unique, cannot be null. XLineId is used by XDevice as a shorthand notation (uuid + index and ctiid attributes). This is a read only tag. The value will be the currently added GeoLocationPolicy pkid. Read-only. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Read only. Only the uuid attribute is read by the AXL API. The generic MGCP follows the IOS Model, but uses more generic terminology to describe the MGCP's structure. All MGCPs have 1..n UNITs, each which contains 1..n SUBUNITs, each which contains 1..n ENDPOINTs. ENDPOINTs are (really, contain) a DEVICE. In the IOS model, the terminology would be SLOTs, VICs, and PORTs. Read-only. Only the uuid attribute is read by the AXL API. The units element is optional when a new MGCP is being added and can be added using addMGCPUnit. UUID that is changed each time the MGCP is updated. For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product. The max attribute identifies the maximum number of endpoints this endpoint list is allowed. When adding endpoint, only endpoint is allowed In the IOS model, ENDPOINT corresponds to a PORT inside a VIC. Only the uuid attribute is read by the AXL API. Supported only by a few MGCP gateways like 26XX, 366X, 37XX, 269X, 38XX, VG224. Supported only by a few MGCP gateways like 26XX, 366X, 37XX, 269X, 38XX, VG224. Applicable for only if PRI variant is QSIG Applicable for only if PRI variant is QSIG The max attribute identifies the maximum number of subunits this subunit list is allowed. In the IOS model, SUBUNIT corresponds to a VIC, and a VIC contains 1 or more PORTs. The max attribute identifies the maximum number of units this unit list is allowed. In the IOS model, UNIT corresponds to a SLOT (Slot Module), and a SLOT contains 1 or more VICs. Default Partition would be Null in case not specified. Only the uuid attribute is read by the AXL API. Default Partition would be Null in case not specified. Only the uuid attribute is read by the AXL API. Default Partition would be Null in case not specified. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by AXL. Only the uuid attribute is read by AXL API. Only the uuid attribute is read by AXL API. Maximum Half Duplex Streams must be a number in the range 0 to 500. Maximum Multicast Connections must be a number in the range 0 to 999999. If isMultiCastEnabled is false then these elements are not necessary.MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. baseMulticastIPAddress and baseMulticastPort must be a unique pair. All Multicast IP Addresses must be in the range 239.1.1.1 to 239.255.255.255 Multicast Base Port number must be an even number in the range 16384 to 32766 Abstract When adding a NumPlan with the AXL API, this sequence is required. For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag. Default Partition would be Null in case not specified. Only the uuid attribute is read by the AXL API. Shorthand object to uniquely identify a Numplan entry by directory number (dn) and paritiion name. Abstract dialPlan is mandatory for patterns with @ in it. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. This tag is not valid for a translation pattern. The CallManager for this Call Park is required. When adding a Call Park with the AXL API, the CallManager is required. Since CallPark is included in the XCallManager type, we do not want to cause a loop in the XML here, so we only allow callManagerId. Not nullable. The prefix used for park-code retrieval. User will dial prefix plus park code to retrieve a parked call. The pattern used to revert the call when the parked call is not retrieved within retrieval timer. To be configured only when reversion pattern is not empty. Only the uuid attribute is read by the AXL API. On Addition always the first member added is itself. Do not specify the first member as itself in an Add request . Also make sure that the priority always starts with 1. It will internally be taken care of during Addition and Updation. This tag is applicable when Pickup Notification Policy is "Visual Alert" or "Visual or Audio Alert". Nullable. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. For an intercom line this tag should be treated as a mandatory tag and the valid values are Auto Answer with Headset and Auto Answer with Speakerphone. A value of 0 means 'none selected'. A value of 0 means 'none selected'. Read-only. Only the uuid attribute is read by the AXL API. This tag is applicable for only intercom lines and if not set, intercom lines will not be active. Only the uuid attribute is read by the AXL API. Only UUID Attribute is read by AXL Only UUID Attribute is read by AXL Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Read Only Read Only If not specified then a default value of '0' is set. This tag is not applicable to networkServiceProtocol PRI NI2. It is a mandatory tag if anychild tag of isdnNSFInfoElement is specified. If not specified then the first record based on the protocol in NSFProtocolServiceMap table will be set as the default value. This parameter will take effect only if the selected network service has a valid parameterName in TypeNSFService. Default value would be Null in case not specified. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. This is applicable only if Cisco support use 1 Enterprise parameter is set. Only the uuid attribute is read by the AXL API. Only UUID Attribute is read by AXL dialPlan is mandatory for patterns with @ in it. Only the uuid attribute is read by the AXL API. Always set as true Only the uuid attribute is read by the AXL API. dialPlan is mandatory for patterns with @ in it. Only the uuid attribute is read by the AXL API. Always set as true Only the uuid attribute is read by the AXL API. Default value would be Null in case not specified. Only the uuid attribute is read by the AXL API. uuid of Pickup Group Only the uuid attribute is read by the AXL API. DEPRECATED: use routePartition/uuid Phone templates describe what features are assigned to what buttons on a particular phone or set of phones. These templates are downloaded to phones and add-on-modules. The template's name. Only the uuid attribute is read by AXL API. Read-Only. The list of buttons on this model of phone. The feature and label of the first button cannot be modified. Describes the ProcessConfig table (used for service parameters) Describes a server running in the CCM cluster. The primary hostname of the process node. The mac address of the host. This field has been deprecated in Seadragon Read-only. AXL API automatically adds the required entries in the RegionMatrix table. Default value would be Null in case not specified. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Not nullable. Read only. Not nullable. Only the uuid attribute is read by the AXL API. Read only. Not nullable. Nullable. Only the uuid attribute is used by the AXL API for inserts and updates. Actually refers to DialPlanTag.Tag in database. Read-only. Only the uuid attribute is read by the AXL API. DEPRECATED: use device/uuid Only the uuid attribute is read by the AXL API. DEPRECATED: use directorynumber/uuid Only the uuid attribute is read by the AXL API. DEPRECATED: use routePartition/uuid Represents a mapping between route groups and route lists. Only the uuid attribute is read by the AXL API. Read-only. Only the uuid attribute is read by the AXL API. This should be written as dialPlanName:digitDiscardInstructionName(NANP:PreDot) Represents a mapping between line groups and hunt lists. Only the uuid attribute is read by the AXL API. Read-only Read-only Read-only. Read-only Read-only Read-only Read-only Although stored in the Device table, the routeList is not really a device. From Device table. From Device table. From Device table. Only the uuid attribute is read by the AXL API. From Device table. Each member is a representaion of an entry in the RouteList table. Although stored in the Device table, the huntList is not really a device. Hunt list are also stored in Route list table. From Device table. From Device table. From Device table. Only the uuid attribute is read by the AXL API. From Device table. Each member is a representation of an entry in the RouteList table. Only the uuid attribute is read by the AXL API. Only if digestAuthentication is enabled this value can be changed. TimePeriod cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Period can be published. Only the uuid attribute is read by the AXL API. TimeSchedule cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Schedule can be published. Read-Only. List of the remoteDestination entries associated with this TodAccess. Name of the remoteDestination Only the uuid attribute is read by the AXL API. Not nullable. Only the uuid attribute is read by the AXL API. Not nullable. Read-only. Since CallPark is included in the XCallManager type, we do not want to cause a loop in the XML here, so we only allow callManagerId. Not nullable. This template should not be a standard template. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. List of mandatory keys for each callstate :: On Hook - NewCall Connected - End Call On Hold - Resume Off Hook - End Call Connected Transfer - Transfer Digits After First - Backward Connected Conference - Conference Ring Out - End Call Off Hook With Feature - End Call Read-Only.The positionId has values starting with 0 and get incremented by 1 for each call state. Only the uuid attribute is read by the AXL API. Read-Only Either Remote Destination Profile or Dual Mode Device can be specified but not both. Once added cannot be updated. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. The directory number to be associated. This directory number must be already associated to remote destination profile. This tag is used only by Cisco Media Termination Point (WS-SVC-CMM) and is a mandatory tag for Cisco Media Termination Point (WS-SVC-CMM) Transcoder. Valid values range from 1 to 4. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by AXL API. For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product. This tag is used only by Cisco Media Termination Point (WS-SVC-CMM) This tag is valid only for Cisco Media Termination Point (WS-SVC-CMM). Valid values for this tag are 32,64,96,128. An entry in the TelecasterSubscribedService table. Only the uuid attribute is read by the AXL API on adds and updates. Read Only Read Only Read Only Read Only Read Only. Value should be between 1 and 100 A T1Port is a T1 Time Slot. Collection of trunk information. What kind of trunk this is (Ground Start, Loop Start, POTS, etc.). The trunk level (e.g., DAL). Inbound, Outbound, or Bothways. Receive pad. Transmit pad. User Group Member Only the uuid attribute is read by the AXL API. User Group This field has been deprecated in Seadragon Also known as controlled devices. Name of device. Only DNs associated with the associatedDevices of the User can be used as primary extension. DN or Pattern Route Partition to which the DN is associated. DN or Pattern Route Partition to which the DN is associated. Read-Only.These groups automatically get added once the user is associated with a directory group. Name of User Group Name of the User Role associated with the user group. The complete profile object. Only the "uuid" attribute is used by the AXL API. The profile name. Maximum wait time for Desk Pickup must be a number in the range 0 to 30000.Not Nullable. Remote Destination Limit must be a number in the range 1 to 10. Not Nullable. Read-Only.These groups automatically get added once the user is associated with a Remote Destination Profile. Name of the remoteDestinationProfile This field has been deprecated. Name of the accessList Read-only. These groups get automatically added once an user is added. Only uuid can be accepted. Read-only. These groups get automatically added once an user is added. This tag is not valid for an application user. Only uuid can be accepted. Primary Device for mobility users Read-Only. List of the todAccess entries associated with this EndUser. Name of the todAccess. Read Only The generic MGCP follows the IOS Model, but uses more generic terminology to describe the MGCP's structure. All MGCPs have 1..n UNITs, each which contains 1..n SUBUNITs, each which contains 1..n ENDPOINTs. ENDPOINTs are (really, contain) a DEVICE. In the IOS model, the terminology would be SLOTs, VICs, and PORTs. Read-only. Only the uuid attribute is read by the AXL API. The units element is optional when a new VG224 is being added and can be added using updateVG224Gateway. In the IOS model, UNIT corresponds to a SLOT (Slot Module). In the IOS model, SUBUNIT corresponds to a VIC, and a VIC contains 1 or more PORTs. The max attribute identifies the maximum number of endpoints this endpoint list is allowed. In the IOS model, ENDPOINT corresponds to a PORT inside a VIC. These tags are applicable only for MGCP. The list of ports on the gateway. List of analog ports on an analog gateway. An analog port on an analog gateway. The portNumber attribute identifies the ordinal value of the port in the gateway. For Gorund Start/Loop Start type of endpoint. For POTS type of endpoint. Not used by T1 Ports. These tags are applicable only for SCCP. This tag determines if the newly added phone is active to determine consumption of license. If set to false the license units will not be consumed. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. Specifies if the phone is configured for device mobility feature or not It contains Product Specific Configuration Information like Fax mode, Modem Passthorugh, etc. Read only. UUID that is changed each time the VG224 is updated. Only the UUID attribute is read by the AXL API. The name of this Voice Mail Pilot's calling search space. Only the UUID attribute is read by the AXL API. Pilot Point The Pilot Point name. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. A string with some restrictions The root of all rules. The URI name of the rule. For example: xmlrule://cisco.com/public/isAnInteger The "type" choice. The input must be a boolean. The input must conform to a valid date format. The input must be a floating-point number. The input must be an integer. The input is a single key compared to a list. Execute a Javascript fragment. The input must be a string (least restrictive). The input must conform to a valid URI format. Is a null value acceptable for this rule? It is possible that a rule might require additional steps of validation. To guard against loops, these subrules must be defined within this rule rather than allowing the rule to reference other rules (however, see XDisplayInstanceParameter). The name of the enterprise parameter to lookup in the database and use its value as this rule's default value. Overrides the hard-coded default if defined. The integer rule determines if the input is a valid integer. What is the default value if none is supplied? Can either be a decimal or hexadecimal value. What is the minimum acceptable value? What is the maximum acceptable value? The string rule determines if the value is a valid string. The default value to return if none is supplied. A regular expression to compare the string against. The maximum length allowed. A flag which states the rule processors should trim/ignore white space from the input before all other processing. The float rule determines if a value is a valid floating point number. The default value if none is supplied. The minimum acceptable value. The maximum acceptable value. The List Rule expresses the correct values of a list (key/value pairs), what the default key value is, and if selecting multiple keys is valid for the list. What is the default key? Can multiple keys be selected? Each option is expressed as a key/value pair. Rule processors should only compare against the key attributes. The value of each option is simply for display. The Dynamic list rule determines the table and columns to build the list from Directs the rule processor to validate the input as a date. Valid date formats are Any, Long (March 15, 2001), Short-US (the default, 03/15/01), and Short-EU (15/03/01). The default is either a specific date (default), or automatically defaulted to today (defaultNow). Should the rule make sure that the date is not in the future? The input is evaluated by a fragment of JavaScript. The JavaScript fragment used to evaluate the input. The fragment should be cordoned off by CDATA tags. The fragment must contain a entry-point function with the following prototype: Array AXLScriptRuleEntryPoint(String inputString) The output is an Array of two values. Array[0] is a boolean value and indicates success (true) or failure (false). Array[1] contains the result of the script. If successful, it should contain a copy of the inputString or other valid return value. If not successful, it should contain an error message. The URI rule determines if a value is a valid URI. The XML format for a rule error that might be thrown by a rule processor. Contains the value of the original input. The name of the rule broken. An integer error code. Error message generated by rule. This lists what services that the specified service is dependent on. The URI of this service dependency. For example: xmldi://cisco.com/serviceDependency/0. The last part of the URI is the enum value of this service. A list of zero or more services that this service depends on. This is the value of the 'enum' column from the TypeService table. Help text. Optional. The warning message. Optional This is the service we are listing dependencies for. The UNIQUE restrictions are simply flags to the user that in the database this value is unique. All requests must extend abstractRequest. All responses must extend abstractResponse. The error code. Optional text message sent with error code. Optional reference to original request. Optional URL to link for more information. Adds a new Common Phone Profile to the database. Contains the Common Phone Profile that was specified by the request. Updates an existing Common Phone Profile in the database. Adds a new SIP Route Pattern to the database. Contains the SIP Route Pattern that was specified by the request. Updates an existing sip route pattern in the database. The route pattern can be specified by its GUID, or by a combination if its pattern, route partition GUID, and route filter GUID. The new pattern for this route pattern. Nullable. The GUID of the new route partition of this route pattern. Nullable. Not nullable. Adds a new DHCP Server to the database. Not nullable. Contains the DHCP Server that was specified by the request. Updates an existing DHCP Server in the database. The GUID of the DHCP Server to be modified. Not nullable. Each DHCPServer is associated with a unique Host Server. only the uuid attribute is read by the AXL API. The valid values ranges from 0 to 1073741824. The valid values ranges from 0 to 1073741824. The valid values ranges from 0 to 1073741824. The valid values ranges from 0 to 1073741824. Adds one new AARGroup to the database. Get the specified AARGroup from the database. Updates the specified entry in AARNeighborhood. Updates a specific entry in the AARDialPrefixMatrix table. The pkid of the entry in the AARDialPrefixMatrix table that is to be modified. The new prefixDigit value for this particular AARGroup relationship. Removes the specified AARGroup from the database. Adds one new phone to the database. Removes the specified phone from the database. The GUID of the phone to be removed. The name of the phone to be removed. Updates an existing IP phone in the database. The name of the phone that you want to update. The GUID of the phone that you want to update. The new name of the phone. Cannot be null. The new description of the phone. Nullable. The GUID of the new Calling Search Space for this phone. Nullable. The name of the new Calling Search Space for this phone. Nullable. The GUID of the new Device Pool for this phone. Nullable. The name of the new Device Pool for this phone. Nullable. The GUID of the new Common Device Config for this phone. Nullable. The name of the new Common Device Config for this phone. Nullable. Only applicable to Phone. Only the uuid attribute is read by AXL API. The GUID of the new Location for this phone. Nullable. The name of the new Location for this phone. Nullable. The GUID of the new Media Resource List for this phone. Nullable. The name of the new Media Resource List for this phone. Nullable. Not nullable. Not nullable. The new load information for this phone. Nullable. The new vendor config for this phone. Nullable. The new trace flag for this phone. Not nullable. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This field has been deprecated in Seadragon The new lines for this phone. If this element is null, then all lines are removed from this phone. Note: If the lines element is present, then all existing lines are removed and replaced with the sub-elements described by the line and lineIdentifier elements. All directory numbers specified must already exist in the database. The GUID of the new Phone Template for this phone. Nullable. The name of the new Phone Template for this phone. Nullable. The new speed-dials for this phone. If this element is null, then all speed-dials are removed from this phone. Note: If the "speeddials" element is present, then all existing speed-dials are removed and replaced with the "speeddial" sub-elements. The new Busy Lamp Fields for this profile. If this element is null, then all Busy Lamp Fields are removed from this profile. Note: If the " Busy Lamp Fields" element is present, then all existing Busy Lamp Fields are removed and replaced with the " Busy Lamp Field" sub-elements. Only the uuid attribute is read by the AXL API. The new Busy Lamp Fields DirectedCallPark for this profile. If this element is null, then all Busy Lamp Fields DirectedCallPark are removed from this profile. Note: If the "Busy Lamp Fields DirectedCallPark" element is present, then all existing Busy Lamp Fields are removed and replaced with the " Busy Lamp Field DirectedCallPark" sub-elements. The new Add-on Modules associated with this phone. If this element is null, then all Add-on Modules are removed from this phone. Note: If the "addOnModules" element is present, then all existing Add-on Modules are removed and replaced with the "addOnModule" sub-elements. All Add-on Modules specified must already exist in the database. Only the uuid attribute is read by the AXL API The new Security Profile for this phone. Nullable. The new Idle Timeout value for this phone. Nullable. The new Authentication URL for this phone. Nullable. The new Directory URL for this phone. Nullable. The new Idle URL for this phone. Nullable. The new Information URL for this phone. Nullable. The new Messages (voice-mail) URL for this phone. Nullable. The new Proxy Server URL for this phone. Nullable. The new IP Services URL for this phone. Nullable. The new Softkey Template for this phone. Nullable. The Extension Mobility block. By default, extension mobility is disabled. To enable, include a default profile and set enableExtensionMobility to true. Only applicable to 7960 and 7940 phones. If enableExtensionMobility is false then these will not appear. The absence of this tag would mean the device would use the current device Settings The ID of the default profile for this device. Nullable. The name of the default profile for this device. Nullable. Not nullable. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. These tags can be updated only if securityProfile is not mentioned in the request. authenticationMode can be updated only if certificateOperation field is Install/Upgrade, Delete or Troubleshoot. keySize can be updated only if certificateOperation field is Install/Upgrade, Delete or Troubleshoot. authenticationString can be updated only if certificateOperation field is Install/Upgrade, Delete or Troubleshoot. Read-only tag. This tag is valid only for devices that support DND. This tag is valid only for devices that support DND. This tag is valid only for devices that support DND. This tag determines if the newly added phone is active to determine consumption of license. If set to false the license units will not be consumed. Applicable only for dual mode phones. Nullable The GUID of the new Mobility User for this phone. Nullable. The userid of the new mobility user for this phone. Nullable. If a blank tag is passed, the existing value of this tag in the database is retained. This tag is valid only for devices that support Secure Tone This tag is valid only for CUMC devices. This field is applicable only to SIP phones. This field is applicable only to SIP phones. This field is applicable only to SIP phones. Only the uuid attribute is read by the AXL API. This tag is applicable only to those devices that support ssh feature. This tag is applicable only to those devices that support ssh feature. This field is applicable only to SIP phones. This field is applicable to only those phones that support Automatic Outbound Call Rollover. Retrieves the specified phone from the database. The GUID of the phone to be retrieved. The name of the phone to be retrieved. Returns the phone specified by the GetPhone request. Adds one new CallerFilterList to the database. Returns the callerFilterList specified by the GetCallerFilterList request. Updates an existing CallerFilterList in the database. Only name and description fields can be updated. The name of the caller filter list to be modified. Not nullable. The GUID of the caller filter list to be modified. Not nullable. The new name for this caller filter list. Not nullable. The new description for this caller filter list. The new end user for this callerFilterList. Nullable. The new members of this caller filter list. Nullable. Nullable. The value accepted and retrieved from the database for this field will be of type XUserLocale in AXLEnums.xsd. Default is not applicable for CommonDeviceConfig API This template should not be a standard template. This application should not Cisco CallManager. This tag is read-only for standard template. This tag is read-only for standard template. If this is set to true for a template which is not default,the old default SoftKeyTemplate will be deSelected. List of mandatory keys for each callstate :: On Hook - NewCall Connected - End Call On Hold - Resume Off Hook - End Call Connected Transfer - Transfer Digits After First - Backward Connected Conference - Conference Ring Out - End Call Off Hook With Feature - End Call Read-Only.The positionId has values starting with 0 and get incremented by 1 for each call state. Mention the name or uuid of softkey template. Adds new Transcoder to the database. Should not be modified for Cisco Media Termination Point (WS-SVC-CMM). The GUID of the new Device Pool for this transcoder. The name of the new Device Pool for this transcoder. The GUID of the new Common Device Config for this transcoder. The name of the new Common Device Config for this transcoder. Used only for Cisco Media Termination Point (WS-SVC-CMM). This tag is valid only for Cisco Media Termination Point (WS-SVC-CMM). Valid values for this tag are 32,64,96,128. Adds a new meet me num plan to the database. Modifies an existing Meet me number in the database. The GUID of the new route partition of this meet me number. Retrieves the specified Meet-me Number/Pattern from the database. Contains the Meet me num plan specified by the request. Removes the specified Meet-me Number/Pattern from the database. The GUID of the new Device Pool for this MOHServer. The name of the new Device Pool for this MOHServer. The GUID of the new location for this MOHServer. Nullable. The name of the new location for this MOHServer. Nullable. Maximum Half Duplex Streams must be a number in the range 0 to 500. Maximum Multicast Connections must be a number in the range 0 to 999999. If isMultiCastEnabled is false then these elements are not necessary.MOHServer will be added to the database without the values of these tags.If the tag isMultiCastEnabled is not specified, then we are allowed to update audioSources details in case there are entries in mohservermulticastinfo table. All Multicast IP Addresses must be in the range 239.1.1.1 to 239.255.255.255 Multicast Base Port number must be an even number in the range 16384 to 32766 Adds new Conference Bridge to the database. Removes the specified Conference Bridge from the database. The GUID of the Conference Bridge to be removed. The name of the Conference Bridge to be removed. Should not be modified for Cisco Conference Bridge(WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Used only for Cisco Video Conference Bridge(IPVC-35xx), Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). This tag is used only for Cisco Conference Bridge Hardware. This tag is used only for Cisco Conference Bridge(WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values for this tag are 32,64,96,128. Valid only for Cisco IOS Enhanced Conference Bridge Retrieves the specified conference bridge from the database. The GUID of the Conference Bridge to be retrieved. The name of the Conference Bridge to be retrieved. Adds a new Pilot User to the database. Removes the specified pilot user from the database. The GUID of the PilotUser to be removed. The user Id of the PilotUser be removed. Updates an existing Pilot User in the database. The userId of the pilot user to modify. The pkid of the pilot user to modify. The new UserId of the pilotUser.Cannot be null. Nullable. Retrieves the specified Pilot User from the database. The GUID of the pilot user to be retrieved.Not nullable. The name of the pilot user to be retrieved.Not nullable. Returns the pilot user specified by the GetPilotUser request. Adds one new hunt group to the database. The new hunt group to be added.Not nullable. Updates an existing hunt group in the database. The new members of this Hunt Group.If this element is null, then all members are removed from this hunt group.Note:If the "members" element is present, then all existing members are removed and replaced with the "member" sub-elements. A list of the new members of this hunt group. Removes the specified hunt group from the database. The GUID of the pilotPoint associated with the hunt group to be retrieved. The name of the pilotPoint associated with the hunt group to be retrieved. Contains the hunt group that was specified by the request. Retrieves the specified hunt group from the database. The GUID of the pilotPoint associated with the hunt group to be Removed. The name of the pilotPoint associated with the hunt group to be Removed. Logs-in the specified user to the specified phone. The GUID of the phone that is being logged-into. Not nullable. The name of hte phone that is being logged-into. Not nullable. The duration of the login. Not nullable. The GUID of the Device Profile to be used. Not nullable. The name of the Device Profile to be used. Not nullable. The LDAP RN of the user that is to be logged-into the phone. Not nullable. Returns "true" if the login was performed successfully. This method logs-out whichever user is logged-into the device. The GUID of the device to perform the log-out on. The name of the device to perform the log-out on. Returns "true" if the log-out was performed successfully. Performs either a hard or soft reset on the specified device. If resetting an MGCP box, then set isMGCP attribute to true. The GUID of the device to perform a reset on. Not nullable. The name of the device to performs a reset on. Not nullable. True performs a hard reset. False performs a soft reset. Not nullable. Not nullable Performs either a hard or soft reset on the specified device. If resetting an MGCP box, then set isMGCP attribute to true. Returns "true" if the reset was performed successfully. Authenticates the user on the basis of pin or password. Applicable for end users only. true indicates that user was authenticated and false indicates that user was not authenticated. This is the IMS result code that will be returned. Adds a new Directory Number to the database. Note that this does NOT associate a directory number with a phone. Please use addPhone or updatePhone to do this. The new line to be added. Not nullable. Removes the specified line from the database. The line can be specified by its GUID, or by a combination of its pattern, Route Partition Id, and Route Filter Id. Updates an existing line (directory number) in the database. Can specify the line with its GUID or by a combination of its pattern, route partition id, and route filter id. The new directory number. Not nullable. The new Route Partition GUID. Nullable. The new Route Partition name. Nullable. The Calling Search Space and destination for Call Forwarding on this line. The Calling Search Space and destination for Call Forwarding when this line is busy for external calls. The Calling Search Space and destination for Call Forwarding when this line is busy for internal calls. The Calling Search Space and destination for Call Forwarding when there is no answer on this line for external calls. The Calling Search Space and destination for Call Forwarding when there is no answer on this line for internal calls. The Calling Search Space and destination for Call Forwarding when there is no coverage on this line for external calls. The Calling Search Space and destination for Call Forwarding when there is no coverage on this line for internal calls. The Calling Search Space and destination for Call Forwarding when the DN is not registered for external calls. The Calling Search Space and destination for Call Forwarding when the DN is not registered for internal calls Only the uuid attribute is read by the AXL API. The only valid values are Auto Answer with Headset and Auto Answer with Speakerphone. A value of 0 means 'none selected'. A value of 0 means 'none selected'. The GUID for the new Presence Group used for this directory number. Nullable. The GUID for the new Calling Search Space used for the Shared Line Appearance for this line. Nullable. The GUID of the new Voice Messaging Profile for this directory number. Nullable. This tag is applicable for only intercom lines and if not set, intercom lines will not be active. Only UUID Attribute is read by AXL Only UUID Attribute is read by AXL Retrieves the specified line (directory number) from the database. Can specify the line with its GUID or by a combination of its pattern, route partition id, and route filter id. Contains the directory number that was specified by the GetLine request. Adds a new user to the user directory. The new user to be added. Removes the specified user from the user directory. The ID of the user to be removed. Not nullable. Updates an existing user in the directory. Specify the user to be modified with their LDAP RN. The userid of the user to be modified. The new first name (given name) of the user. Nullable. The new last name (surname) of the user. Nullable. The new password for the user. Not nullable. The new PIN (personal identification number) for the user. Not nullable. The new telephone number for the user. Nullable. This field has been deprecated in Seadragon The new department for the user. Nullable. The new manager for the user. Nullable. The new locale for the user. Not nullable. The devices associated with this user. Also known as controlled devices. If "associateDevices" is present, then all current associated devices are replaced by the devices listed underneath the "associatedDevices" element. If this element is null, then all devices are removed from the user. Nullable. Name of device. If this element is null, then all devices are removed from the user. Only DNs associated with the associatedDevices of the User can be used as primary extension. DN or Pattern Route Partition to which the DN is associated. DN or Pattern Route Partition to which the DN is associated. The new PC associated with this user. Nullable. This field has been deprecated in Seadragon This field has been deprecated in Seadragon This field has been deprecated in Seadragon This field has been deprecated in Seadragon If this element is null, then all phone profiles are removed from the user. If this element is null, then all the phone profiles are removed from the user. The complete profile object. Only the "uuid" attribute is used by the AXL API. The profile name. Maximum wait time for Desk Pickup must be a number in the range 0 to 30000. Not Nullable. Remote Destination Limit must be a number in the range 1 to 10. Not Nullable. Only uuid can be accepted. Either pwdCredUserMustChange can be true or pwdCredUserCantChange can be true. Not Nullable. Either pwdCredUserMustChange can be true or pwdCredUserCantChange can be true. Not Nullable. Ony uuid attribute can be accepted. Either pinCredUserMustChange can be true or pinCredUserCantChange can be true. Not Nullable. Either pinCredUserMustChange can be true or pinCredUserCantChange can be true. Not Nullable. Primary devices for mobility users Retrieves the specified user from the directory. The ID of the user to be retrieved. Not nullable. Contains the user that was specified by the GetUser request. Adds a new application user. The new application user to be added. Updates an existing application user in the directory. Specify the user to be modified with their LDAP RN. The userid of the user to be modified. The new password for the user. Valid range is 1-127 characters. Not nullable. Only the uuid attribute is read by the AXL API. Either pwdCredUserMustChange can be true or pwdCredUserCantChange can be true. Not Nullable. Either pwdCredUserMustChange can be true or pwdCredUserCantChange can be true. Not Nullable. Valid range is 1-42 characters. Only the uuid attribute is read by the AXL API. The devices associated with this user. Also known as controlled devices. If "associateDevices" is present, then all current associated devices are replaced by the devices listed underneath the "associatedDevices" element. If this element is null, then all devices are removed from the user. Nullable. Name of device. If this element is null, then all devices are removed from the user. The existing association with User Groups will be removed and new set of associations with user groups will be created. Name of User Group Contains the user that was specified by the GetUser request. Returns either the GUID of the object that was altered, or returns true if the operation was successful. Whichever is appropriate for the corresponding request. Adds a new device profile to the databse. The new profile to be added. Not nullable. Removes the specified device profile from the database. The GUID of the profile to be removed. Not nullable. The name of the profile to be removed. Not nullable Modifies an existing device profile in the database. The name of the profile that you want to update. The GUID of the profile that you want to update. The new name of the profile. Cannot be null. The new description of the profile. Nullable. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This tag is not valid for a device profile. The new lines for this profile. If this element is null, then all lines are removed from this profile. Note: If the lines element is present, then all existing lines are removed and replaced with the sub-elements described by the line and lineIdentifier elements. All lines specified must already exist in the database. The GUID of the new Phone Template for this profile. Nullable. The new speed-dials for this profile. If this element is null, then all speed-dials are removed from this profile. Note: If the "speeddials" element is present, then all existing speed-dials are removed and replaced with the "speeddial" sub-elements. The new Busy Lamp Fields for this profile. If this element is null, then all Busy Lamp Fields are removed from this profile. Note: If the " Busy Lamp Fields" element is present, then all existing Busy Lamp Fields are removed and replaced with the " Busy Lamp Field" sub-elements. The new Add-on Modules associated with this profile. If this element is null, then all Add-on Modules are removed from this profile. Note: If the "addOnModules" element is present, then all existing Add-on Modules are removed and replaced with the "addOnModule" sub-elements. All Add-on Modules specified must already exist in the database. The new subscribed services for this profile. If this element is null, then all services are removed from this profile. Note: If the "services" element is present, then all existing services are removed and replaced with the "service" sub-elements. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. This tag is valid only for devices that support DND. This tag is valid only for devices that support DND. This tag is valid only for devices that support DND. Retrieves the specified Device Profile from the database. The GUID of the profile to be retrieved. Not nullable. The name of the profile to be retrieved. Not nullable. Contains the device profile that was specified by the request. Not nullable. Not nullable. Not nullable. Not nullable. The new members of TODAccess. If "members" is present, then all current members of this are removed and replaced by the "member" sub-elements. Nullable. Adds a new route partition to the database. The route partition to be added. Not nullable. Updates an existing route partition in the database. The name of the route partition to be modified. Not nullable. The GUID of the route partition to be modified. Not nullable. The new name for this route partition. Not nullable. The new description for this route partition. Nullable. The new Time Schedule GUID for this Route Partition. Nullable. Not nullable. Removes the specified route partition from the database. The GUID of the route partition to be removed. Not nullable. The name of the route partition to be removed. Not nullable. Retrieves the specified route partition from the database. The GUID of the route partition to be retrieved. Not nullable. The name of the route partition to be removed. Not nullable. Contains the route partition that was specified by the request. Contains the calling search space that was specified by the request. Adds a new Calling Search Space to the database. The calling search space to be added. Not nullable. Updates an existing Calling Search Space in the database. The name of the calling search space to be modified. Not nullable. The GUID of the calling search space to be modified. Not nullable. The new name for this calling search space. Not nullable. The new description for this calling search space. The new members of this calling search space. If "members" is present, then all current members of this calling search space are removed and replaced by the "member" sub-elements. Nullable. Abstract Abstract Abstract This is the uuid of CallPickupGroup Some NumPlans do not require a Route Filter, thus these elements can be null. Retrieves the specified Translation Pattern from the database. Can specify the translation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. Contains the translation pattern that was specified by the request. Removes the specified translation pattern from the database. Can specify the translation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. Adds a new translation pattern to the database. The new pattern to be added. Updates an existing translation pattern in the database. Can specify the translation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. The new pattern for this tranlsation pattern. Nullable. The GUID of the new route partition of this tranlsation pattern. Nullable. Not nullable. Nullable. Nullable. The GUID of the new route filter for this translation pattern. Nullable. This tag is not valid for a translation pattern. The GUID of the new calling search space for this translation pattern. Nullable. Default value would be Null in case not specified. Only the uuid attribute is read by the AXL API. Adds a new transformation pattern to the database. The new pattern to be added. Retrieves the specified Transformation Pattern from the database. Can specify the transformation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. Contains the transformation pattern that was specified by the request. Updates an existing transformation pattern in the database. Can specify the transformation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. The new pattern for this transformation pattern. Nullable. The GUID of the new route partition of this transformation pattern. Nullable. Not nullable. Nullable. The GUID of the new route filter for this transformation pattern. Nullable. Removes the specified transformation pattern from the database. Can specify the transformation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. Adds a new called party transformation pattern to the database. The new pattern to be added. Retrieves the specified Called Party Transformation Pattern from the database. Can specify the transformation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. Contains the Called Party transformation pattern that was specified by the request. Updates an existing Called Party transformation pattern in the database. Can specify the transformation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. The new pattern for this transformation pattern. Nullable. The GUID of the new route partition of this transformation pattern. Nullable. Nullable. The GUID of the new route filter for this transformation pattern. Nullable. Removes the specified Called Party Transformation pattern from the database. Can specify the transformation pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. Retrieves the specified Route Pattern from the database. Can specify the route pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. Contains the route pattern that was specified by the request. Removes the specified route pattern from the database. Can specify the route pattern with its GUID or by a combination of its pattern, route partition id, and route filter id. Adds a new Route Pattern to the database. The new route pattern to be added. Not nullable. Updates an existing route pattern in the database. The route pattern can be specified by its GUID, or by a combination if its pattern, route partition GUID, and route filter GUID. The new pattern for this route pattern. Nullable. The GUID of the new route partition of this route pattern. Nullable. Not nullable. The GUID of the new route filter for this route pattern. Nullable. The new destination for this route pattern. Can be a gateway or a route list. Not nullable. Read Only Read Only If blank tag is passed then the NSF Information is removed for the corresponding route pattern. If not specified then a default value of '0' is set. This tag is not applicable to networkServiceProtocol PRI NI2. It is a mandatory tag if anychild tag of isdnNSFInfoElement is specified. If not specified then the first record based on the protocol in NSFProtocolServiceMap table will be set as the default value. This parameter will take effect only if the selected network service has a valid parameterName in TypeNSFService. Default value would be Null in case not specified. Only the uuid attribute is read by the AXL API. Retrieves the specified Hunt Pilot from the database. Can specify the hunt pilot with its GUID or by a combination of its pattern, route partition id, and route filter id. Contains the hunt pilot that was specified by the request. Removes the specified hunt pilot from the database. Can specify the hunt pilot with its GUID or by a combination of its pattern, route partition id, and route filter id. Adds a new Hunt PIlot to the database. The new hunt pilot to be added. Not nullable. Updates an existing hunt pilot in the database. The hunt pilot can be specified by its GUID, or by a combination if its pattern, route partition GUID, and route filter GUID. The new pattern for this hunt pilot. Nullable. The GUID of the new Route Partition of this hunt pilot. Nullable. Not nullable. The GUID of the new route filter for this route pattern. Nullable. The new destination for this hunt pilot. Can only be a hunt list. Not nullable. This is applicable only if Cisco support use 1 Enterprise parameter is set. Only the uuid attribute is read by the AXL API. Adds a new Line Group to the database. Updates an existing line group in the database. The new name for this line group. This new line group members for this route group. All of the line group's current members are replaced by the "member" sub-elements specified. A list of the new members of this Line group. Contains the line group that was specified by the request. Adds a new Route Group to the database. Updates an existing route group in the database. The new name for this route group. This new route group members for this route group. All of the route group's current members are replaced by the "member" sub-elements specified. A list of the new members of this route group. Contains the route group that was specified by the request. Add a new Route List to the database. Updates an existing Route List in the database. The name of the route list to modify (from the Device table). The pkid of the route list to modify (from the Device table). The new name for this Route List. Not nullable. The new description for this Route List. Nullable. Not nullable. Only the uuid attribute is read by the AXL API. Not nullable. The new list of route groups that are part of this route list. A route list must have at least one member. Contains the Route List that was specified by the request. Add a new Hunt List to the database. Updates an existing Hunt List in the database. The name of the hunt list to modify (from the Device table). The pkid of the hunt list to modify (from the Device table). The new name for this Hunt List. Not nullable. The new description for this Hunt List. Nullable. Not nullable. Only the uuid attribute is read by the AXL API. Not nullable. The new list of line groups that are part of this route list. A route list must have at least one member. Contains the Hunt List that was specified by the request. Adds a new CTI Route Point to the database. Modifies an existing CTI Route Point in the database. The new name of this Route Point. Not nullable. The new description for this Route Point. Nullable. The new Calling Search Space for this Route Point. Nullable. Nullable. The new Device Pool for this Route Point. Not nullable. Not nullable. The GUID of the new Common Device Config for this device. The name of the new Common Device Config for this device. The new location for this Route Point. Nullable. Nullable. Only the uuid attribute is read by the AXL API. The new lines for this phone. If this element is null, then all lines are removed from this phone. Note: If the lines element is present, then all existing lines are removed and replaced with the sub-elements described by the line and lineIdentifier elements. All directory numbers specified must already exist in the database. Only the uuid attribute is read by the AXL API Contains the CTI Route Point that was specified by the request. Adds a new DHCP Subnet to the database. Not nullable. Contains the DHCP Subnet that was specified by the request. Updates an existing DHCP Subnet in the database. The GUID of the DHCP Subnet to be modified. Not nullable. Each DHCPSubnet is associated with a unique DHCP Server. only the uuid attribute is read by the AXL API. Value between 0 to 1073741824. Value between 0 to 1073741824. Value between 0 to 1073741824. Value between 0 to 1073741824. Adds a new Dial Plan to the database. Modifies an existing Dial Plan in the database. The new name for this Dial Plan. Not nullable. The new description for this Dial Plan. Contains the Dial Plan that was specified by the request. Adds a new Dial Plan Tag to the databse Modifies an existing Dial Plan Tag in the database. The name (or "tag" in the database) for this Dial Plan Tag. Not nullable. The new Dial Plan for this Dial Plan Tag. Note that the "uuid" attribute is used. Not nullable. Not nullable. The new Operator type for this Dial Plan Tag. Not nullable. The new boolean value for the suppressFromRouteFilter property of this Dial Plan Tag. Not nullable. Contains the Dial Plan Tag that was specified by the request. Adds a new Call Park num plan to the database. Modifies an existing Call Park num plan in the database. The new directory number for this Call Park num plan. Not Nullable. The new Route Partition GUID for this Call Park num plan. Nullable. The GUID of the new CallManager associated to this Call Park num plan. Not Nullable. Not nullable. Retrieves the specified Call Park num plan from the database. Contains the Call Park num plan specified by the request. Removes the specified Call Park num plan from the database. Adds a new Directed Call Park num plan to the database. Modifies an existing Directed Call Park num plan in the database. The new directory number for this Call Park num plan. Not Nullable. The new Route Partition GUID for this Call Park num plan. Nullable. The new prefix used for park-code retrieval. User will dial prefix plus park code to retrieve a parked call. The new pattern used to revert the call when the parked call is not retrieved within retrieval timer. To be configured only when reversion pattern is not empty. Only the uuid attribute is read by the AXL API. Retrieves the specified Directed Call Park num plan from the database. Contains the Directed Call Park num plan specified by the request. Removes the specified Directed Call Park num plan from the database. Adds a new Call Pickup Group to the database. Modifies and existing Call Pickup Group in the database. On Addition always the first member added is itself. Do not specify the first member as itself in an Add request . Also make sure that the priority always starts with 1. It will internally be taken care of during Addition and Updation. A list of the new members of this Pickup group. This tag is applicable when Pickup Notification Policy is "Visual Alert" or "Visual or Audio Alert". Retrieves the specified Call Pickup Group from the database. Contains the Call Pickup Group specified by the request. Removes the specified Call Pickup Group from the database. Adds a new Digit Discard Instruction to the database. Modifies and existing Digit Discard Instruction in the database. The new name for this Digit Discard Instruction. Not nullable. The GUID or name of the new Dial Plan for this Digit Discard Instruction. Not nullable. The "members" element will contain the new list of members of this Digit Discard Instruction. If the "members" element is present, any existing members are deleted and replaced by the new "member" elements. Nullable. Contains the Digit Discard Instruction specified by the request. This method uses the specified phone to create an auto-generated device profile. The name of the phone to use to create the profile. Not nullable. The GUID of the phone to use to create the profile. Not nullable. This abstract method is to be extended by the "list" methods. The string to search for. Can contain SQL wildcard characters. It will be used onlt when first tag is specified. This method searches for all phones whose name matches the specified search string. This response is returned by the listPhoneByXXX methods. It includes the phone GUID, name, and product. The response to listPhoneByName. For each phone returned, lists its name, product type, and model type. This method searches for all phones whose description matches the specified search string. The response to listPhoneByDescription. For each phone returned, lists its name, product type, and model type. This method searches for all users whose first and last names match the given pattern. The '*' character is used as the wildcard. The first name to search for. Can contain the '*' character as a wildcard. The last name to search for. Can contain the '*' character as a wildcard. The maximum number of users to be displayed. It will be used only when first tag is specified and searchLimit tag value is zero It will be used only when searchLimit tag value is zero The is element will contain all the users who matched the search string supplied by listUserByName. For each user returned, the user's ldapRN, firstname, and lastname is specified. This request returns the all entries in the NumPlan table which match the type given. The type (pattern usage) of Route Plan to return. Not nullable. Response to listRoutePlanByType request. For each route plan returned, the directory number, route partition name, and usage type is specified. This method returns the number of devices found. The caller specifies what class of device they want counted. The class of device that is to be counted. Cannot be null. Response to GetNumDevices. Returns an integer value which is the number of devices found. The class of device counted is represented by the "class" attribute. This method can be used to list all service parameters (include Enterprise-Wide parameters) for a particular Process Node and service type. The process node. The type of service. Contains all the service parameters as found by ListServiceParameters. A list of "param" elements. Eache "param" element represents a service parameter. If no service parameters were found, then no "param" elements will be present. The name of this service parameter. The value of this service parameter. This method searches for all Calling Search Spaces in the database whose name matches the search string. This response is returned by the listCSSByXXX methods. The response to listCSSByName. Contains all the Calling Search Spaces that matched the search string. This is a utility object that created because many of the Get, Remove, and Update methods allow the user to specify either the name or the uuid. Not nullable. Not nullable. This is a utility object that created because many of the Get, Remove, and Update methods allow the user to specify the uuid. Not nullable. Adds a new device pool to the database. Update an existing device pool in the database. The name of the Device Pool to update. Not nullable. The UUID of the Device Pool to update. Not nullable. The new name for this Device Pool. Not nullable. Nullable. Not nullable. Not nullable. Nullable. Not nullable. Not nullable. -1 means use system default. The value accepted and retrieved from the database for this field will be of type XRevertPriority in AXLEnums.xsd. Only the uuid attribute is read by the AXL API Only the uuid attribute is read by the AXL API Only the uuid attribute is read by the AXL API Only the uuid attribute is read by the AXL API Contains the device pool specified by the request. Adds a new CallManager group to the database. Update an existing CallManager group in the database. Not nullable. Not nullable. The new members of this CallManager group. If "members" is present, then all current members of this CallManager group are removed and replaced by the "member" sub-elements. Nullable. Contains the CallManager group specified by the request. Adds one new VG224 Gateway to the database. Retrieves the specified VG224 gateway info from the database. The GUID of the VG224 Gateway to be retrieved. The domain name of the VG224 to be retrieved. Returns the VG224 specified by the GetVG224 request. Removes the specified VG224 Gateway from the database. The GUID of the VG224 to be removed. The domain name of the VG224 to be removed. Updates an existing VG224 Gateway information in the database. The domain name of the VG224 that you want to update. The GUID of the VG224 that you want to update. The new domain name of the VG224. Cannot be null. The new description of the VG224. Nullable. The GUID of the new Call Manager Group for this VG224. The name of the new Call Manager Group name for this VG224. The units element is optional when a new VG224 is being added and can be added using updateVG224Gateway. In the IOS model, UNIT corresponds to a SLOT (Slot Module). In the IOS model, SUBUNIT corresponds to a VIC, and a VIC contains 1 or more PORTs. The max attribute identifies the maximum number of endpoints this endpoint list is allowed. If new endpoints are mentioned to be added to the gateway, the tags would be mandatory as in the addVG224Req. In the IOS model, ENDPOINT corresponds to a PORT inside a VIC. The name of the phone that you want to update. The GUID of the phone that you want to update. The new description of the phone. Nullable. The GUID of the new Calling Search Space for this phone. Nullable. The name of the new Calling Search Space for this phone. Nullable. The GUID of the new Device Pool for this phone. Nullable. The name of the new Device Pool for this phone. Nullable. The GUID of the new Common Device Config for this phone. Nullable. The name of the new Common Device Config for this phone. Nullable. Only applicable to Phone. The GUID of the new Common Phone Config for this phone. Not Nullable. The GUID of the new Location for this phone. Nullable. The name of the new Location for this phone. Nullable. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This tag is valid only for phones, SIP trunks and voice mail ports. Not nullable. The GUID of the new Security Profile for this phone. Only uuid attribute is read by AXL API. Only uuid attribute is read by AXL API. Valid only for gateways using SCCP Protocol The new lines for this phone. If this element is null, then all lines are removed from this phone. Note: If the lines element is present, then all existing lines are removed and replaced with the sub-elements described by the line and lineIdentifier elements. All directory numbers specified must already exist in the database. These tags are applicable only for MGCP. The list of ports on the gateway. List of analog ports on an analog gateway. An analog port on an analog gateway. The portNumber attribute identifies the ordinal value of the port in the gateway. For Gorund Start/Loop Start type of endpoint. For POTS type of endpoint. Not used by T1 Ports. These tags are applicable only for SCCP. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. Specifies if the phone is configured for device mobility feature or not It contains Product Specific Configuration Information like Fax mode, Modem Passthorugh, etc. Adds a new VoiceMail Pilot to the database. Updates the specified Voice Mail Pilot from the database. The GUID of the Voice Mail Pilot to be updated Only the UUID attribute is read by the AXL API. The new description of the device. Nullable. Setting isDefault tag as false would not disable this VoiceMailPilot as Default. Instead, the corresponding tag of another VoiceMailPilot should be set to true Retrieves the specified Voice Mail Pilot from the database. The GUID of the Voice Mail Pilot to be retrieved. Contains the VoiceMail Pilot specified by the request. Removes the specified Voice Mail Pilot from the database. The GUID of the Voice Mail Pilot to be removed Adds a new VoiceMail Profile to the database. Update an existing VoiceMail Profile in the database. Not nullable. The new description of the device. Nullable. Only UUID attribute is read by the AXL API.Setting isDefault tag as false would not disable this VoiceMailProfile as Default. Instead, another VoiceMailProfile should be set to true Contains the VoiceMail Profile specified by the request. Adds a new VoiceMail Port to the database. Update an existing VoiceMail Port in the database. Not nullable. The new description of the device. Nullable. The GUID of the new Calling Search Space for this device. Nullable. The name of the new Calling Search Space for this device. Nullable. The GUID of the new Device Pool for this device. Not nullable. The name of the new Device Pool for this device. Not nullable. The GUID of the new Common Device Config for this device. The name of the new Common Device Config for this device. The GUID of the new Location for this device. Nullable. The name of the new Location for this device. Nullable. The GUID of the new Media Resource List for this device. Nullable. The name of the new Media Resource List for this device. Nullable. The new load information for this device. Nullable. The new vendor configuration XML for this device. Nullable. The new trace flag for this device. Not nullable. The new security profile for this device. Not nullable. The new line for this voice mail port. Nullable. Only uuid attribute is read by AXL API Contains the VoiceMail Port specified by the request. Adds a new Gateway endpoint to the database. XGateway is abstract, so the user of AddGatewayEndpoint must specify a complex type that extends XGateway. Update an existing Gateway endpoint in the database. Not nullable. The new description of the device. Nullable. Protocol Side can only be modified on PRI gateways. Not nullable. The GUID of the new Calling Search Space for this device. Nullable. The name of the new Calling Search Space for this device. Nullable. The GUID of the new Device Pool for this device. Not nullable. The name of the new Device Pool for this device. Not nullable. The GUID of the new Common Device Config for this device. The name of the new Common Device Config for this device. The new Device Destination flag for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways, except FXS gateways. Not nullable. The GUID of the new Location for this device. Nullable. The name of the new Location for this device. Nullable. The GUID of the new Media Resource List for this device. Nullable. The name of the new Media Resource List for this device. Nullable. The new load information for this device. Nullable. The new vendor configuration XML for this device. Nullable. The new trace flag for this device. Not nullable. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. Also known as networkLocale. Nullable. Applicable to PRI gateways.For analog and T1 gateways, this tag comes under ports. Not appicable to T1-CAS and FXO ports. Not appicable to T1-CAS and FXO ports. At this point, you can edit the elements specific to PRI, BRI, T1, or Analog gateways. The new list of ports for this gateway. This list of ports replaces any pre-existing ports on this gateway. The new trunk selection order for this gateway. Not nullable. Applicable for only if PRI variant is QSIG Applicable for only if PRI variant is QSIG Not nullable. Not nullable. Not nullable. Nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. This field has been deprecated for SeaDragon. Not nullable. Neither the present attribute nor the value of this element is nullable. Not nullable. Not nullable. Not nullable. Not nullable. The value of numDigits must be either 0 to 32 or 99. Not nullable. Nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. This tag enables the significant digits for the gateway; if the tag is set to true, the value of the 'numDigits' element is used as Significant Digits for the gateway. This tag should have a value of false if numDigits is set to 99. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Nullable. Not nullable. Not nullable. Not nullable. This field has been deprecated in Seadragon Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. This field has been deprecated for SeaDragon. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. The value of numDigits must be either 0 to 32 or 99. Nullable. Not nullable. Not nullable. Not nullable. This tag enables the significant digits for the gateway; if the tag is set to true, the value of the 'numDigits' element is used as Significant Digits for the gateway. This tag should have a value of false if numDigits is set to 99. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. Not nullable. This field has been deprecated for SeaDragon. If the ports element is included in the request, then all existing ports on this gateway will be replaced by the ports found here. Not nullable. Not nullable. Not nullable. Only the uuid attribute is read by the AXL API. Applicable only for DigitalAccess PRI Gateways Only uuid attribute is read by AXL API Not applicable for FXS ports Contains the Gateway specified by the request. Adds a new Route Filter to the database. Update an existing Route Filter in the database. Not nullable. The GUID of the new Dial Plan for this Route Filter. Not Nullable. The name of the new Dial Plan for this Route Filter. Not Nullable. The new members of this Route Filter. If this element is null, then all members are removed from this route filter. Note: If the "members" element is present, then all existing members are removed and replaced with the "member" sub-elements. Contains the Route Filter specified by the request. Retrieves the specified service parameter from the database. The pkid of the service parameter in the ProcessConfig table. Name of the service parameter. Not nullable. The process Node that this the service parameter belongs to. Not nullable. The service that this service parameter belongs to. Contains the service parameter specified by the request. Modifies an existing service parameter's value. The new value of the service parameter. Nullable in some cases. Must be a valid value for this service parameter's data type or an error will be returned. Would return either the GUID of the object that was altered, or return true if the operation was successful. Whichever is possible for this request. Adds a new Location to the database. Update an existing Location in the database. Not nullable. Not nullable. Not nullable. Contains the Location specified by the request. Adds a new CMCInfo to the database. Update an existing CMCInfo in the database. The code of the CMCInfo that you want to update. The GUID of the CMCInfo that you want to update. Not nullable. This tag has been deprecated Access the specified CMCInfo from the database. The GUID of the CMCInfo to be retrieved. The code of the CMCInfo to be retrieved. Contains the CMCInfo specified by the request. Adds a new FACInfo to the database. Update an existing FACInfo in the database. Not nullable. Not nullable. Not nullable Contains the FACInfo specified by the request. Adds a new Region to the database and automatically adds associated regions to the Region Matrix table. Update an existing region in the database. The name of the Region to update. Not nullable. The UUID of the Region to update. Not nullable. The new name for this Region. Not nullable. Contains the Region specified by the request. Updates a specific entry in the RegionMatrix table. The pkid of the entry in the RegionMatrix table that is to be modified. The new bandwidth value for this particular region relationship. Adds one new MGCP to the database. Adds one new MGCP Unit to the MGCP Gateway. The pkid of the MGCP gateway for which the unit is being added the domain name of MGCP Gateway for which the unit is being added Adds one new MGCP Subunit to the MGCP Gateway's unit(slot). The pkid of the MGCP gateway for which the subunit is being added The domain name of MGCP Gateway for which the subunit is being added The unit(slot) index for which the subunit is being added Adds one and only one new MGCP Endpoint(port) to the MGCP Gateway's subunit. The pkid of the MGCP gateway for which the endpoint is being added The domain name of MGCP Gateway for which the endpoint is being added The unit(slot) index for which the endpoint is being added The subunit index for which the endpoint is being added Retrieves the specified MGCP gateway info from the database. The GUID of the MGCP Gateway to be retrieved. The domain name of the MGCP to be retrieved. Returns the MGCP specified by the GetMGCP request. Removes the specified MGCP Gateway from the database. The GUID of the MGCP to be removed. The domain name of the MGCP to be removed. Removes the specified unit(slot) of MGCP Gateway from the database. The GUID of the MGCP whose unit is to be removed. The domain name of the MGCP whose unit is to be removed. The unit or slot number to be removed from the MGCP gateway(specified as the attribute index) Removes the specified subunit of MGCP Gateway's unit from the database. The GUID of the MGCP whose unit's subunit is to be removed. The domain name of the MGCP whose subunit is to be removed. The unit number from which the subunit is to be removed from the MGCP gateway(specified as the attribute "index") The subunit to be removed from the MGCP gateway(specified as the attribute "index") Removes the specified endpoint(port) of MGCP Gateway from the database. The GUID of the MGCP whose endpoint is to be removed. The domain name of the MGCP whose endpoint is to be removed. The unit(slot) number from which the endpoint is to be removed(specified as the attribute "index") The subunit from which the endpoint(port) is to be removed (specified as the attribute "index") The endpoint(port) number to be removed (specified as the attribute "index") Updates an existing MGCP Gateway information in the database. To modify unit, use removeMGCPUnit-addMGCPUnit. To modify subunit, use removeMGCPSubunit-addMGCPSubunit To modify endpoint, use removeMGCPEndpoint-addMGCPEndpoint The domain name of the MGCP that you want to update. The GUID of the MGCP that you want to update. The new domain name of the MGCP. Cannot be null. The new description of the MGCP. Nullable. Read only Read only The GUID of the new Call Manager Group for this MGCP. The name of the new Call Manager Group name for this MGCP. The new load information for this phone. Nullable. Adds a new CallManager to the database. Update an existing CallManager in the database. Not nullable. Nullable. Auto-registration information block. Nullable. Nullable. Nullable. Nullable. Nullable. Port information block. Not nullable. MGCP port information block. Not nullable. Not nullable. Contains the CallManager specified by the request. Contains the MobileSmartClientProfile specified by the request. Adds a new ProcessNode to the database. Update an existing ProcessNode in the database. Not nullable. Nullable. Nullable. Contains the ProcessNode specified by the request. Sends a request for all ProcessNodes in the database. Contains all the process nodes in the database. Sends a request for all ProcessNodes in the database for this particular service. Contains all the process nodes in the database that matched the service type in the request. Retrieves the specified Process Node Service from the database. The pkid of the Process Node Service you wish to retrieve. The process Node that this the process node service belongs to. Not nullable. The service that this process node service belongs to. Contains the Process Node Service specified by the request. Modifies an existing Process Node Service's value. This field has been deprecated in Seadragon This method searches for all Route Partitions whose name matches the specified search string. This response is returned by the listRoutePartitionByXXX methods. The response to listRoutePartitionsByName. Contains all the Route Partitions that matched the search string. This method searches for all Device Pools whose name matches the specified search string. This response is returned by the listDevicePoolByXXX methods. The response to listDevicePoolsByName. Contains all the Device Pools that matched the search string. This method searches for all Phone Templates whose name matches the specified search string. This response is returned by the listPhoneTemplateByXXX methods. The response to listPhoneTemplatesByName. Contains all the Phone Templates that matched the search string. This method searches for all devices of the specified device class and whose name matches the specified search string. This response is returned by the listDeviceByXXX methods. The response to listDeviceByNameAndClass. Contains all the device that matched the search string and class type. This method searches for all devices which are subscribed to the specified telecaster service. This response is returned by the listDeviceByServiceName methods. The response to listDeviceByServiceName. Contains all the device that matched the ServiceName. This method searches for all MOH Audio Sources whose name matches the specified search string. This response is returned by the listMOHAudioSourceByXXX methods. The response to listMOHAudioSourcesByName. Contains all the MOH Audio Sources that matched the search string. Specifies which MOH Audio Source to retrieve. Specifies which MOH Audio Source to modify. Specifies which MOH Audio Source to retrieve. Specifies which MOH Audio Source to remove. This method searches for all Media Resource Lists whose name matches the specified search string. This response is returned by the listMediaResourceListByXXX methods. The response to listMediaResourceListsByName. Contains all the Media Resource Lists that matched the search string. This method searches for all Media Resource Groups whose name matches the specified search string. This response is returned by the listMediaResourceGroupByXXX methods. The response to listMediaResourceGroupsByName. Contains all the Media Resource Groups that matched the search string. Not nullable. Not nullable. Not nullable. The new members of this User Group. If this element is null, then all members are removed from this user group. Note: If the "members" element is present, then all existing members are removed and replaced with the "member" sub-elements. Add new members to the User Group. It doesn't delete old members. Note: If the member is already added to the User Group an error will be thrown. Remove members from the UserGroup. Note: Only members already associated with this User Group can be deleted. List all AAR Groups that match the specified name pattern. The response to listAARGroupByName. Contains all the AAR Groups that matched the search string. List all Voice Mail Profiles that match the specified name pattern. The response to listVoiceMailProfileByName. Contains all the Voice Maile Profiles that matched the search string. This method searches for all Gatekeepers whose name matches the specified search string. This response is returned by the listGatekeeperByXXX methods. The response to listGatekeepersByName. Contains all the Gatekeepers that matched the search string. Not nullable. Not nullable. Not nullable. Not nullable. The GUID of the new Common Device Config for this device. The name of the new Common Device Config for this device. The new Device Destination flag for Trunk to Trunk Transfer and Drop Conference Feature is required for H323 Gateways and Trunks. Not Nullable. Not nullable. This tag is not valid for H323Phone and H323Trunk. Not nullable. This tag is not valid for H323Phone and H323Trunk. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. Applicable only for H323Phones and H323Trunks.Not applicable for H323Gateways. Only the uuid attribute is read by the AXL API. Applicable only for H323 trunks and H323 gateways Only the uuid attribute is read by the AXL API Applicable only for H323 trunks Applicable only for H323Gateway and H323Trunk. Applicable only for H323Gateway and H323Trunk. Applicable only for H323 Phones. If set to True, mediaResourceList must be mentioned and mtpRequired must be set to True. enableOutboundFaststart must be set to true for it to be read. Not Nillable. The new lines for this phone. If this element is null, then all lines are removed from this phone. Note: If the lines element is present, then all existing lines are removed and replaced with the sub-elements described by the line elements. All directory numbers specified must already exist in the database. The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable. Applicable for only if PRI variant is QSIG Applicable for only if PRI variant is QSIG Applicable only for H323Gateways/Trunks Applicable only for H323Gateways/Trunks Applicable only for H323Gateways/Trunks Applicable only for H323Gateways/Trunks The value of significantDigits must be either from 0 to 32 or 99. Here 99 means All. The tag will not be applicable for any type of Inter-Cluster trunk Applicable only for Non-Gatekeeper controlled ICT trunk's. Should be set only when ictPassingPrecedenceLevelThroughUUIE is set to true. WARNING: SQL Large Text and BLOB columns cannot be fetched along with other columns. A Large Text or BLOB column must be selected in its own SQL query. The GUID of the new Common Device Config for this device. The name of the new Common Device Config for this device. Not nullable. This tag is not valid for SIPTrunk. Not nullable. This tag is not valid for SIPTrunk. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. This setting only affects devices that support MLPP. Valid characters for Destination Address are letters, numbers, dashes and dots(periods). IP address should have four 8-bit numbers seperated by periods. Host name should start with letter and end with letter or number. This tag is ignored and destAddrIsSRV is set to false if destinationaddress is an IP address and destinationport is mentioned correctly. This tag depends on destAddrIsSRV. It is mandatory when destAddrIsSRV is false or when destination address is an IP address. Valid values between 1024 to 65535 (inclusive) The new Security Profile for this phone. Nullable. The ampersand is a reserved character in xml. It can be escaped as "&" The value of sigDigits must be either from 0 to 32 or 99. Here 99 means All. enable attribute is Read-Only. If sigDigits is 0-32 then enable is true, if signDigits is 99 then enable is false. Characters which are not valid for caller name are ampersand, braces, less than or greater than, percentage sign, double quotes, square brackets and pipe. This tag is valid only if srtpAllowed is set to false. Only the uuid attribute is read by the AXL API Adds a new SIP Realm. The new SIP Realm to be added. Removes the specified SIP Realm. The GUID of the SIP Realm to be removed. Not nullable. The SIP Realm to be removed. Not nullable. Updates an SIP Realm. Specify the SIP Realm to be modified . Not nullable. The userId of the user. Not Nullable. The digestCredentials to be modified.Not Nullable. Retrieves the specified SIP Realm . The GUID of the SIP Realm to be retrieved. Not nullable. The SIP Realm to be retrieved. Not nullable. Contains the SIP Realm that was specified by the GetSIPRealm request. Returns either the GUID of the object that was altered, or returns true if the operation was successful. Whichever is appropriate for the corresponding request. Adds new SIPProfile to the database. Only the uuid attribute is read by the AXL API. Adds a new Recording Profile. The new Recording Profile to be added. Removes the specified Recording Profile. The GUID of the Recording Profile to be removed. Not nullable. The Recording Profile to be removed. Not nullable. Updates a Recording Profile. Specify the Recording Profile to be modified . Not nullable. Only the uuid attribute is read by the AXL API. The DN or URL of the recorder to be modified.Not Nullable. Retrieves the specified Recording Profile . The GUID of the Recording Profile to be retrieved. Not nullable. The Recording Profile to be retrieved. Not nullable. Contains the Recording Profile that was specified by the getRecordingProfile request. Adds a new Pilot Point to the database. Updates an existing Pilot Point in the database. The new name for this Pilot Point. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. This field has been deprecated in Seadragon Only the uuid attribute is read by the AXL API. Contains the Pilot Point that was specified by the request. The only valid values for enableUPS are true, True, false and False. The only valid values for enableUPC are true, True, false and False. The ID of the user to be retrieved. Not nullable. Contains the license capabilities for the user specified in the getLicenseCapabilities request. The GUID of the new route partition of this meet me number. Removes the specified Mobile Voice Access from the database. It is mandatory to give either handoffNumber or DTMFNumber tag in the request. Both can't be null. Retrieves mobility configuration information. It is mandatory to give either handoffNumber or DTMFNumber tag in the request. Both can't be null. Removes the specified DTMF/Handoff pattern from the database. This tag is used to modify the fields corresponding to one button. The feature and label of the first button cannot be modified. Returns the phone template specified by the getPhoneTemplate request. If this tag is set to true, zero is inserted into the database for failedLogon. Failed logon must be a number in the range 0 to 100. Reset Failed logon attempts must be a number in the range 1 to 120. If this tag is set to true, zero is inserted into the database for lockoutDuration. Lockout duration must be a number in the range 0 to 1440. Credential change duration must be a number in the range 0 to 129600. If this tag is set to true, zero is inserted into the database for credExpiresAfter. Credential expires after must be a number in the range 0 to 365. Minimum credential length must be a number in the range 0 to 64. Stored number of previous credentials must be a number in the range 0 to 25. Inactive days allowed must be a number in the range 0 to 5000. Expiry warning days must be a number in the range 0 to 90. Only if digestAuthentication is enabled this value can be changed. Adds a new Remote Destination. The new Remote Destination to be added. Updates a Remote Destination. Specify the Remote Destination to be modified . The new destination number for this remote destination. Not nullable. The line association for this remote destination. If this element is null, then all line associations are removed from this remote destination. Note: If the lineAssciations element is present, then all existing line associations are removed and replaced with the sub-elements described by the lineAssociation element. All directory numbers specified must already exist in the database. Contains the Remote Destination that was specified by the GetRemoteDestination request. Returns either the GUID of the object that was altered, or returns true if the operation was successful. Whichever is appropriate for the corresponding request. Adds a new Remote Destination Profile. The new Remote Destination Profile to be added. Updates a Remote Destination profile. Specify the Remote Destination profile to be modified . The name of the remote destination profile that you want to update. The GUID of the remote destination profile that you want to update. The new name of the remote destination profile. Cannot be null. The new description of the remote destination profile. Nullable. The GUID of the new Calling Search Space for this phone. Nullable. The GUID of the new Device Pool for this remote destination profile. Nullable. The name of the new Device Pool for this remote destination profile. Nullable. Not nullable. Not nullable. The new lines for this remote destination profile. If this element is null, then all lines are removed from this remote destination profile. Note: If the lines element is present, then all existing lines are removed and replaced with the sub-elements described by the line and lineIdentifier elements. All directory numbers specified must already exist in the database. Only the uuid attribute is read by the AXL API. Only the uuid attribute is read by the AXL API. This tag is valid only for devices that support DND. This tag is valid only for devices that support DND. Contains the Remote Destination Profile that was specified by the getRemoteDestinationProfile request. Returns either the GUID of the object that was altered, or returns true if the operation was successful. Whichever is appropriate for the corresponding request. Adds a new Resource Priority Namespace to the database. Not nullable. Not nullable. Contains the Resource Priority Namespace that was specified by the request. Updates an existing Resource Priority Namespace in the database. The name of the ResourcePriorityNamespace to be modified. Not nullable. The GUID of the ResourcePriorityNamespace to be modified. Not nullable. The new namespace for this ResourcePriorityNamespace. Not nullable. Contains the Resource Priority Default Namespace Updates an existing Resource Priority Default Namespace in the database. The name of the ResourcePriorityNamespace to be set as Default. Adds a new ResourcePriorityNamespaceList to the database. Contains the ResourcePriorityNamespaceList specified by the request. Update an existing ResourcePriorityNamespaceList in the database. Not nullable. The new members of this ResourcePriorityNamespaceList. If "members" is present, then all current members of this are removed and replaced by the "member" sub-elements. Nullable. This API call is used to execute a Structured Query Language query against the database. The sql element would contain the SQL statement. If special characters are required, wrap the SQL command inside a CDATA element. Each row element can contain any number of sub-elements, each sub-element is a column from that row in the result set. The response message to executeSQLQuery. The return element represents the result set, which can contain 0 or more rows of data. Each row can have any number of elements as defined by columns specified in the SQL Query. The name of each sub-element of the row element represents the column name, the value of each sub-element of the row element is the corresponding value of that column in the database. Request to execute an SQL update. This API call is used to execute a Structured Query Language Update against the database. The sql element would contain the SQL statement Rows updated indicates the number of rows updated by the SQL update. The response message to executeSQLUpdate. Adds a new GeoLocation Contains the GeoLocation that was specified in the request. Updates an existing Geo Location Adds a new GeoLocationPolicy Contains the GeoLocationPolicy that was specified in the request. Updates an existing Geo Location One of the two choices is mandatory if PolicyMatrix table needs to be updated Add the policies provided in the request into Matrix table Removes the policies provided in the request into Matrix table Updates the existing policies. Only typeLogicalPartitioningPolicy field can be updated Removes all the existing entries in Matrix table and then adds the values in the request into the Matrix table Adds a new GeoLocationFilter Contains the GeoLocationFilter that was specified in the request. Updates an existing Geo Location