AXL-Client-Simple
view release on metacpan or search on metacpan
share/AXLSoap.xsd view on Meta::CPAN
</xsd:element>
<xsd:element name="softkeyTemplateName" type="xsd:string"/>
</xsd:choice>
<xsd:element name="loginUserId" type="axlapi:String255" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Read-only for IP Phones.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:sequence minOccurs="0">
<xsd:annotation>
<xsd:documentation>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 ...
</xsd:annotation>
<xsd:choice>
<xsd:annotation>
<xsd:documentation>The absence of this tag would mean the device would use the current device Settings</xsd:documentation>
</xsd:annotation>
<xsd:element name="defaultProfile" type="axlapi:XProfile" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Only the "uuid" attribute is applicable to the AXL API. Not nullable.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="defaultProfileName" type="axlapi:String50" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>The name of the default profile for this device. Not nullable.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
<xsd:element name="enableExtensionMobility" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation> Not nullable.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:choice minOccurs="0">
<xsd:annotation>
<xsd:documentation>The current user profile in use by this device. Read-only.</xsd:documentation>
</xsd:annotation>
<xsd:element name="currentProfile" type="axlapi:XProfile" nillable="false">
<xsd:annotation>
<xsd:documentation>Read-only.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="currentProfileName" type="axlapi:String50" nillable="false">
<xsd:annotation>
<xsd:documentation>Read-only.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
<xsd:element name="loginTime" type="xsd:nonNegativeInteger" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Read-only.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="loginDuration" type="xsd:nonNegativeInteger" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Read-only.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:element name="currentConfig" minOccurs="0">
<xsd:annotation>
<xsd:documentation>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 informa...
</xsd:annotation>
<xsd:complexType>
<xsd:sequence minOccurs="0">
<xsd:element name="userHoldMOHAudioSourceId" type="axlapi:XMOHAudioSourceId" nillable="false" minOccurs="0"/>
<xsd:choice minOccurs="0">
<xsd:element name="phoneTemplate" type="axlapi:XPhoneTemplate">
<xsd:annotation>
<xsd:documentation>Only the uuid attribute is read by the AXL API.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="phoneTemplateName" type="axlapi:String50" nillable="false"/>
</xsd:choice>
<xsd:element name="mlppDomainId" type="xsd:int" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>This setting only affects devices that support MLPP.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="mlppIndicationStatus" type="xsd:string" nillable="false" minOccurs="0"><!--This field is of the type axl:XStatus in AXLEnums.xsd-->
<xsd:annotation>
<xsd:documentation>This setting only affects devices that support MLPP.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="preemption" type="xsd:string" nillable="false" minOccurs="0"><!--This field is of the type axl:XPreemption in AXLEnums.xsd-->
<xsd:annotation>
<xsd:documentation>This setting only affects devices that support MLPP.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:choice minOccurs="0">
<xsd:element name="softkeyTemplate" type="axlapi:XSoftkeyTemplate">
<xsd:annotation>
<xsd:documentation>Only the uuid attribute is read by the AXL API.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="softkeyTemplateName" type="xsd:string"/>
</xsd:choice>
<xsd:element name="ignorePresentationIndicators" type="xsd:boolean" default="false" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>The new Ignore Presentation Indicators flag for Hospitality Feature is required for most phones and device profiles.Not Nullable.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="singleButtonBarge" type="axlapi:XBarge" nillable="false" minOccurs="0">
<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="xsd:string" nillable="false" minOccurs="0"><!--This field is of the type axl:XStatus in AXLEnums.xsd-->
<xsd:annotation>
<xsd:documentation>This tag is valid only for devices that support JAL.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="callInfoPrivacyStatus" type="xsd:string" nillable="false" minOccurs="0"/><!--This field is of the type axl:XStatus in AXLEnums.xsd-->
<xsd:element name="dndStatus" type="xsd:boolean" nillable="false" minOccurs="0"/>
<xsd:element name="dndRingSetting" type="xsd:string" nillable="true" minOccurs="0"/><!--This field is of the type axl:XRingSetting in AXLEnums.xsd-->
<xsd:element name="dndOption" type="axlapi:XDNDOption" nillable="false" minOccurs="0"/>
<xsd:element name="alwaysUsePrimeLine" type="xsd:string" default="Default" minOccurs="0"/><!--This field is of the type axl:XStatus in AXLEnums.xsd-->
<xsd:element name="alwaysUsePrimeLineforVoiceMessage" type="xsd:string" default="Default" minOccurs="0"/><!--This field is of the type axl:XStatus in AXLEnums.xsd-->
<xsd:element name="logMissedCalls" type="xsd:boolean" default="true" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
share/AXLSoap.xsd view on Meta::CPAN
<xsd:attribute name="uuid" type="axlapi:XUUID"/>
<xsd:attribute name="portNumber" type="xsd:positiveInteger" use="required"/>
</xsd:complexType>
<xsd:complexType name="XButton">
<xsd:annotation>
<xsd:documentation>A button on a phone template.</xsd:documentation>
</xsd:annotation>
<xsd:sequence minOccurs="0">
<xsd:element name="feature" type="xsd:string"><!--This field is of the type axl:XFeature in AXLEnums.xsd-->
<xsd:annotation>
<xsd:documentation>The feature invoked by this button.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="label" type="axlapi:String50" minOccurs="0">
<xsd:annotation>
<xsd:documentation>The label to display for this button.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="uuid" type="axlapi:XUUID"/>
<xsd:attribute name="buttonNumber" type="xsd:positiveInteger"/>
</xsd:complexType>
<xsd:complexType name="XCallForwardInfo">
<xsd:sequence>
<xsd:element name="forwardToVoiceMail" type="xsd:boolean" default="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:choice minOccurs="0">
<xsd:element name="callingSearchSpace" type="axlapi:XCallingSearchSpace">
<xsd:annotation>
<xsd:documentation>Only the uuid attribute is read by the AXL API.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="callingSearchSpaceName" type="axlapi:String50"/>
</xsd:choice>
<xsd:choice minOccurs="0">
<xsd:annotation>
<xsd:documentation>This tag is applicable only for callForwardAll.</xsd:documentation>
</xsd:annotation>
<xsd:element name="secondaryCallingSearchSpace" type="axlapi:XCallingSearchSpace">
<xsd:annotation>
<xsd:documentation>Only the uuid attribute is read by the AXL API.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="secondaryCallingSearchSpaceName" type="axlapi:String50"/>
</xsd:choice>
<xsd:element name="destination" type="axlapi:String50" minOccurs="0"/>
<xsd:element name="duration" type="xsd:int" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="XHuntForwardInfo">
<xsd:sequence>
<xsd:element name="usePersonalPreferences" type="xsd:boolean" default="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Use original Called DN forward no-coverage settings</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:choice minOccurs="0">
<xsd:element name="callingSearchSpace" type="axlapi:XCallingSearchSpace">
<xsd:annotation>
<xsd:documentation>Only the uuid attribute is read by the AXL API.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="callingSearchSpaceName" type="axlapi:String50"/>
</xsd:choice>
<xsd:element name="destination" type="axlapi:String50" minOccurs="0"/>
<xsd:element name="maxHuntduration" type="xsd:integer" nillable="false" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="XCallingSearchSpace">
<xsd:sequence minOccurs="0">
<xsd:element name="name" type="axlapi:UniqueName50"/>
<xsd:element name="description" type="axlapi:String50" minOccurs="0"/>
<xsd:element name="clause" type="axlapi:String1024" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Read-only.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialPlanWizardGenId" type="xsd:nonNegativeInteger" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Read-only.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="members">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="member" type="axlapi:XCallingSearchSpaceMember" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="partitionUsage" type="axlapi:XPartitionUsage" nillable="true" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="uuid" type="axlapi:XUUID"/>
</xsd:complexType>
<xsd:complexType name="XCallingSearchSpaceMember">
<xsd:sequence>
<xsd:choice>
<xsd:element name="routePartition" type="axlapi:XRoutePartition">
<xsd:annotation>
<xsd:documentation>Only the uuid attribute is read by the AXL API.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="routePartitionId" type="axlapi:XUUID">
<xsd:annotation>
<xsd:documentation>DEPRECATED: use routePartition/uuid</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="routePartitionName" type="axlapi:String50"/>
</xsd:choice>
</xsd:sequence>
<xsd:attribute name="index" type="xsd:positiveInteger"/>
share/AXLSoap.xsd view on Meta::CPAN
<xsd:element name="defaultNow" type="xsd:boolean"/>
</xsd:choice>
<xsd:element name="min" type="xsd:date" minOccurs="0"/>
<xsd:element name="max" type="xsd:date" minOccurs="0"/>
<xsd:element name="restrictTo" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Should the rule make sure that the date is not in the future?</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Past"/>
<xsd:enumeration value="Future"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="XBooleanRule">
<xsd:sequence>
<xsd:element name="default" type="xsd:boolean"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="XScriptRule">
<xsd:annotation>
<xsd:documentation>The input is evaluated by a fragment of JavaScript.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="comment" type="xsd:string"/>
<xsd:element name="script">
<xsd:annotation>
<xsd:documentation>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 ...
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:whiteSpace value="preserve"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="XURIRule">
<xsd:annotation>
<xsd:documentation>The URI rule determines if a value is a valid URI.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="default" type="xsd:anyURI" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="XRuleError">
<xsd:annotation>
<xsd:documentation>The XML format for a rule error that might be thrown by a rule processor.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="invalidValue" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Contains the value of the original input.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ruleBroken" type="xsd:Name">
<xsd:annotation>
<xsd:documentation>The name of the rule broken.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="errorCode" type="xsd:integer" default="0">
<xsd:annotation>
<xsd:documentation>An integer error code.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="errorText" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Error message generated by rule.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- *********************************************************** -->
<!-- Service Dependency objects -->
<!-- *********************************************************** -->
<xsd:complexType name="XServiceDependency">
<xsd:annotation>
<xsd:documentation>This lists what services that the specified service is dependent on.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="name" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>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.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dependencies">
<xsd:annotation>
<xsd:documentation>A list of zero or more services that this service depends on.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="dependency" type="xsd:nonNegativeInteger" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>This is the value of the 'enum' column from the TypeService table.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="help" type="axlapi:String1024" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Help text. Optional.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="warning" type="axlapi:String1024" minOccurs="0">
<xsd:annotation>
<xsd:documentation>The warning message. Optional</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="service" type="xsd:nonNegativeInteger" use="required">
<xsd:annotation>
<xsd:documentation>This is the service we are listing dependencies for.</xsd:documentation>
share/AXLSoap.xsd view on Meta::CPAN
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:all>
<xsd:attribute name="sequence" type="xsd:unsignedLong" use="optional"/>
</xsd:complexType>
<xsd:complexType name="Response" abstract="false">
<xsd:complexContent>
<xsd:extension base="axlapi:Envelope">
<xsd:choice>
<xsd:element name="response" type="axlapi:APIResponse">
<xsd:annotation>
<xsd:documentation>Completely abstracted, specific response payloads must be defined.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="error" type="axlapi:Error"/>
</xsd:choice>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="Request" abstract="false">
<xsd:complexContent>
<xsd:extension base="axlapi:Envelope">
<xsd:all>
<xsd:element name="request" type="axlapi:APIRequest">
<xsd:annotation>
<xsd:documentation>Completely abstracted, the request payload must be defined.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
-->
<xsd:complexType name="APIRequest" abstract="true">
<xsd:annotation>
<xsd:documentation>All requests must extend abstractRequest.</xsd:documentation>
</xsd:annotation>
<xsd:attribute name="sequence" type="xsd:unsignedLong" use="optional"/>
</xsd:complexType>
<xsd:complexType name="APIResponse" abstract="true">
<xsd:annotation>
<xsd:documentation>All responses must extend abstractResponse.</xsd:documentation>
</xsd:annotation>
<xsd:attribute name="sequence" type="xsd:unsignedLong" use="optional"/>
</xsd:complexType>
<xsd:complexType name="Error">
<xsd:sequence>
<xsd:element name="code" type="xsd:long">
<xsd:annotation>
<xsd:documentation>The error code.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="message" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Optional text message sent with error code.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="request" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Optional reference to original request.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="url" type="xsd:anyURI" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Optional URL to link for more information.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- axlsoap.xsd -->
<xsd:complexType name="AddCommonPhoneConfigReq">
<xsd:annotation>
<xsd:documentation>Adds a new Common Phone Profile to the database.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="axlapi:APIRequest">
<xsd:sequence>
<xsd:element name="newCommonPhoneConfig" type="axlapi:XCommonPhoneConfig" nillable="false"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="addCommonPhoneConfig" type="axlapi:AddCommonPhoneConfigReq"/>
<xsd:element name="addCommonPhoneConfigResponse" type="axlapi:StandardResponse"/>
<xsd:complexType name="CommonPhoneConfigReq">
<xsd:complexContent>
<xsd:extension base="axlapi:APIRequest">
<xsd:sequence>
<xsd:choice>
<xsd:element name="name" type="axlapi:String100"/>
<xsd:element name="uuid" type="axlapi:XUUID"/>
</xsd:choice>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="getCommonPhoneConfig" type="axlapi:CommonPhoneConfigReq"/>
<xsd:complexType name="GetCommonPhoneConfigRes">
<xsd:annotation>
<xsd:documentation>Contains the Common Phone Profile that was specified by the request.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="axlapi:APIResponse">
<xsd:sequence>
<xsd:element name="return">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="CommonPhoneConfig" type="axlapi:XCommonPhoneConfig"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="getCommonPhoneConfigResponse" type="axlapi:GetCommonPhoneConfigRes"/>
<xsd:complexType name="UpdateCommonPhoneConfigReq">
<xsd:annotation>
<xsd:documentation>Updates an existing Common Phone Profile in the database.</xsd:documentation>
( run in 1.782 second using v1.01-cache-2.11-cpan-140bd7fdf52 )