AXLSoap - ORPhone

complexType ORPhone

diagram

namespace

http://www.cisco.com/AXL/API/15.0

children

product class protocol protocolSide callingSearchSpaceName devicePoolName commonDeviceConfigName commonPhoneConfigName networkLocation locationName mediaResourceListName networkHoldMohAudioSourceId userHoldMohAudioSourceId automatedAlternateRoutingCssName aarNeighborhoodName mlppIndicationStatus preemption useTrustedRelayPoint securityProfileName sipProfileName cgpnTransformationCssName geoLocationName geoLocationFilterName lines phoneTemplateName primaryPhoneName ringSettingIdleBlfAudibleAlert ringSettingBusyBlfAudibleAlert blfDirectedCallParks addOnModules userLocale networkLocale services softkeyTemplateName defaultProfileName singleButtonBarge joinAcrossLines builtInBridgeStatus callInfoPrivacyStatus ownerUserName packetCaptureMode subscribeCallingSearchSpaceName rerouteCallingSearchSpaceName presenceGroupName certificateOperation authenticationMode keySize keyOrder ecKeySize deviceMobilityMode dndOption dndRingSetting mobilityUserIdName phoneSuite phoneServiceDisplay mtpPreferedCodec dialRulesName outboundCallRollover alwaysUsePrimeLine alwaysUsePrimeLineForVoiceMessage featureControlPolicy deviceTrustMode confidentialAccess cgpnIngressDN wifiHotspotProfile wirelessLanProfileGroup elinGroup mraServiceDomain

used by

element

GetPhoneOptionsRes/return/phone

attributes

Name	Type	Use	Default	Fixed	Annotation
ctiid	xsd:positiveInteger
uuid	axlapi:XUUID

source

<xsd:complexType name="ORPhone">
<xsd:sequence minOccurs="0">
    <xsd:element name="product" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>Product ID string. read-only except when creating a device.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="class" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>Class ID string. Class information is read-only except when creating a device.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="protocol" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>Protocol option is read-only,except when creating a device.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="protocolSide" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>Side information is read-only except when creating a device</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="callingSearchSpaceName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="devicePoolName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="commonDeviceConfigName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="commonPhoneConfigName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="networkLocation" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="locationName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="mediaResourceListName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="networkHoldMohAudioSourceId" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is not valid for H323Phone,H323trunk and SIPTrunk</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="userHoldMohAudioSourceId" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is not valid for H323Phone,H323trunk and SIPTrunk</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="automatedAlternateRoutingCssName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="aarNeighborhoodName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="mlppIndicationStatus" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This setting only affects devices that support MLPP.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="preemption" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This setting only affects devices that support MLPP.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="useTrustedRelayPoint" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="securityProfileName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="sipProfileName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This Tag is valid only for SIP Phones and SIP Trunks</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="cgpnTransformationCssName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="geoLocationName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="geoLocationFilterName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="lines" minOccurs="0" maxOccurs="1">
      <xsd:complexType>
        <xsd:choice minOccurs="0">
          <xsd:element name="line" type="axlapi:ORPhoneLine" minOccurs="0" maxOccurs="unbounded">
            <xsd:annotation>
              <xsd:documentation>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.</xsd:documentation>
            </xsd:annotation>
          </xsd:element>
          <xsd:element name="lineIdentifier" type="axlapi:ORNumplanIdentifier" minOccurs="0" maxOccurs="unbounded">
            <xsd:annotation>
              <xsd:documentation>The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag</xsd:documentation>
            </xsd:annotation>
          </xsd:element>
        </xsd:choice>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="phoneTemplateName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="primaryPhoneName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="ringSettingIdleBlfAudibleAlert" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="ringSettingBusyBlfAudibleAlert" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="blfDirectedCallParks" minOccurs="0" maxOccurs="1">
      <xsd:complexType>
        <xsd:sequence minOccurs="0">
          <xsd:element name="blfDirectedCallPark" type="axlapi:ORBLFDirectedCallPark" minOccurs="0" maxOccurs="unbounded"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="addOnModules" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>Additional modules attached to the Phone.There can be 0,1, 2 or 3.</xsd:documentation>
      </xsd:annotation>
      <xsd:complexType>
        <xsd:sequence minOccurs="0">
          <xsd:element name="addOnModule" type="axlapi:ORAddOnModule" minOccurs="0" maxOccurs="3"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="userLocale" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="networkLocale" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="services" minOccurs="0" maxOccurs="1">
      <xsd:complexType>
        <xsd:sequence minOccurs="0">
          <xsd:element name="service" type="axlapi:ORSubscribedService" minOccurs="0" maxOccurs="unbounded"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="softkeyTemplateName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="defaultProfileName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>The name of the default profile for this device.Not Nullable.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="singleButtonBarge" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is valid only for devices that support SBB.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="joinAcrossLines" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is valid only for devices that support JAL..</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="builtInBridgeStatus" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="callInfoPrivacyStatus" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="ownerUserName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>Read-only for IP Phones.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="packetCaptureMode" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="subscribeCallingSearchSpaceName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>Support for this tag has been removed for IMS phones from 9.0</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="rerouteCallingSearchSpaceName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="presenceGroupName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="certificateOperation" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="authenticationMode" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="keySize" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="keyOrder" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="ecKeySize" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="deviceMobilityMode" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>Specifies if the phone is configured for device mobility or not.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="dndOption" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is valid only for devices that support DND.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="dndRingSetting" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is valid only for devices that support DND.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="mobilityUserIdName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>The userid of the mobility user for this phone.Nullable.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="phoneSuite" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>If a blank tag is passed ,the value of the default is inserted into the database.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="phoneServiceDisplay" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="mtpPreferedCodec" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This field is applicable only to SIP phones.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="dialRulesName" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="outboundCallRollover" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is valid only for devices that Automatic Outbound Callrollover</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="alwaysUsePrimeLine" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="alwaysUsePrimeLineForVoiceMessage" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="featureControlPolicy" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is valid only for RT Phones.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="deviceTrustMode" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>This tag is valid only for TIP endpoints</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="confidentialAccess" minOccurs="0" maxOccurs="1">
      <xsd:complexType>
        <xsd:sequence minOccurs="0">
          <xsd:element name="confidentialAccessMode" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
          <xsd:element name="confidentialAccessLevel" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="cgpnIngressDN" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="wifiHotspotProfile" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="wirelessLanProfileGroup" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="elinGroup" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="mraServiceDomain" type="axlapi:ORFkType" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="ctiid" type="xsd:positiveInteger"/>
<xsd:attribute name="uuid" type="axlapi:XUUID"/>
</xsd:complexType>

attribute ORPhone/@ctiid

type	xsd:positiveInteger
source	<xsd:attribute name="ctiid" type="xsd:positiveInteger"/>

attribute ORPhone/@uuid

type

axlapi:XUUID

facets

Kind	Value	Annotation
pattern	\{........-....-....-....-............\}

source

<xsd:attribute name="uuid" type="axlapi:XUUID"/>

element ORPhone/product

diagram

type