diagram | |||||||||||||
namespace | http://www.cisco.com/AXL/API/15.0 | ||||||||||||
type | extension of axlapi:APIRequest | ||||||||||||
properties |
|
||||||||||||
children | uuid destination newName newDestination answerTooSoonTimer answerTooLateTimer delayBeforeRingingCell ownerUserId enableUnifiedMobility remoteDestinationProfileName enableExtendAndConnect ctiRemoteDeviceName dualModeDeviceName isMobilePhone enableMobileConnect lineAssociations timeZone todAccessName mobileSmartClientName mobilityProfileName singleNumberReachVoicemail dialViaOfficeReverseVoicemail removeRingSchedule addRingSchedule ringSchedule accessListName | ||||||||||||
used by |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:complexType name="UpdateRemoteDestinationReq"> <xsd:complexContent> <xsd:extension base="axlapi:APIRequest"> <xsd:sequence> <xsd:choice> <xsd:element name="uuid" type="axlapi:XUUID"/> <xsd:element name="destination" type="xsd:string" nillable="false" minOccurs="1" maxOccurs="1"/> </xsd:choice> <xsd:element name="newName" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="newDestination" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="answerTooSoonTimer" type="axlapi:XInteger" default="1500" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="answerTooLateTimer" type="axlapi:XInteger" default="19000" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="delayBeforeRingingCell" type="axlapi:XInteger" default="4000" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="ownerUserId" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="enableUnifiedMobility" type="axlapi:boolean" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="remoteDestinationProfileName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>If you are giving value to dualModeDeviceName then you can't give value to remoteDestinationProfileName,viceversa</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="enableExtendAndConnect" type="axlapi:boolean" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ctiRemoteDeviceName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="dualModeDeviceName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="isMobilePhone" type="axlapi:boolean" default="false" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="enableMobileConnect" type="axlapi:boolean" default="true" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="lineAssociations" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>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.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="lineAssociation" type="axlapi:XLineAssociation" minOccurs="1" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="timeZone" type="axlapi:XTimeZone" default="Etc/GMT" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="todAccessName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="mobileSmartClientName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This tag is not applicable for dualmode phones</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="mobilityProfileName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This tag is applicable only to CUMC devices.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="singleNumberReachVoicemail" type="axlapi:XVMAvoidancePolicy" default="Use System Default" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="dialViaOfficeReverseVoicemail" type="axlapi:XVMAvoidancePolicy" default="Use System Default" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This tag is for Mobility Identity</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:choice minOccurs="0"> <xsd:sequence minOccurs="0"> <xsd:element name="removeRingSchedule" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> <xsd:element name="addRingSchedule" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:element name="ringSchedule" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag. Passing a blank ringSchedule tag in updateRemoteDestination request will result in setting the time schedule to All the time.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:choice> <xsd:element name="accessListName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> |
diagram | |||||||
type | axlapi:XUUID | ||||||
properties |
|
||||||
facets |
|
||||||
source | <xsd:element name="uuid" type="axlapi:XUUID"/> |
diagram | |||||
type | xsd:string | ||||
properties |
|
||||
source | <xsd:element name="destination" type="xsd:string" nillable="false" minOccurs="1" maxOccurs="1"/> |
diagram | |||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="newName" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="newDestination" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||
type | axlapi:XInteger | ||||||||||
properties |
|
||||||||||
source | <xsd:element name="answerTooSoonTimer" type="axlapi:XInteger" default="1500" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||
type | axlapi:XInteger | ||||||||||
properties |
|
||||||||||
source | <xsd:element name="answerTooLateTimer" type="axlapi:XInteger" default="19000" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||
type | axlapi:XInteger | ||||||||||
properties |
|
||||||||||
source | <xsd:element name="delayBeforeRingingCell" type="axlapi:XInteger" default="4000" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="ownerUserId" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||
type | axlapi:boolean | ||||||
properties |
|
||||||
facets |
|
||||||
annotation |
|
||||||
source | <xsd:element name="enableUnifiedMobility" type="axlapi:boolean" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="remoteDestinationProfileName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>If you are giving value to dualModeDeviceName then you can't give value to remoteDestinationProfileName,viceversa</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||
type | axlapi:boolean | ||||||
properties |
|
||||||
facets |
|
||||||
annotation |
|
||||||
source | <xsd:element name="enableExtendAndConnect" type="axlapi:boolean" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="ctiRemoteDeviceName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="dualModeDeviceName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||
type | axlapi:boolean | ||||||||||
properties |
|
||||||||||
facets |
|
||||||||||
source | <xsd:element name="isMobilePhone" type="axlapi:boolean" default="false" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||
type | axlapi:boolean | ||||||||||
properties |
|
||||||||||
facets |
|
||||||||||
source | <xsd:element name="enableMobileConnect" type="axlapi:boolean" default="true" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||
properties |
|
||||||
children | lineAssociation | ||||||
annotation |
|
||||||
source | <xsd:element name="lineAssociations" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>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.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="lineAssociation" type="axlapi:XLineAssociation" minOccurs="1" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | |||||||
type | axlapi:XLineAssociation | ||||||
properties |
|
||||||
children | uuid pattern routePartitionName | ||||||
source | <xsd:element name="lineAssociation" type="axlapi:XLineAssociation" minOccurs="1" maxOccurs="unbounded"/> |
diagram | |||||||||||
type | axlapi:XTimeZone | ||||||||||
properties |
|
||||||||||
source | <xsd:element name="timeZone" type="axlapi:XTimeZone" default="Etc/GMT" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="todAccessName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="mobileSmartClientName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This tag is not applicable for dualmode phones</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="mobilityProfileName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This tag is applicable only to CUMC devices.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||
type | axlapi:XVMAvoidancePolicy | ||||||||||
properties |
|
||||||||||
source | <xsd:element name="singleNumberReachVoicemail" type="axlapi:XVMAvoidancePolicy" default="Use System Default" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||
type | axlapi:XVMAvoidancePolicy | ||||||||||
properties |
|
||||||||||
annotation |
|
||||||||||
source | <xsd:element name="dialViaOfficeReverseVoicemail" type="axlapi:XVMAvoidancePolicy" default="Use System Default" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This tag is for Mobility Identity</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||
type | extension of axlapi:XCommonMembersExtension | ||||||
properties |
|
||||||
children | member | ||||||
source | <xsd:element name="removeRingSchedule" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> |
diagram | |||||||
type | axlapi:XRingingSchedule | ||||||
properties |
|
||||||
children | startTime endTime startDay endDay | ||||||
source | <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> |
diagram | |||||||
type | extension of axlapi:XCommonMembersExtension | ||||||
properties |
|
||||||
children | member | ||||||
source | <xsd:element name="addRingSchedule" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> |
diagram | |||||||
type | axlapi:XRingingSchedule | ||||||
properties |
|
||||||
children | startTime endTime startDay endDay | ||||||
source | <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> |
diagram | |||||||
type | extension of axlapi:XCommonMembersExtension | ||||||
properties |
|
||||||
children | member | ||||||
annotation |
|
||||||
source | <xsd:element name="ringSchedule" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag. Passing a blank ringSchedule tag in updateRemoteDestination request will result in setting the time schedule to All the time.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> |
diagram | |||||||
type | axlapi:XRingingSchedule | ||||||
properties |
|
||||||
children | startTime endTime startDay endDay | ||||||
source | <xsd:element name="member" type="axlapi:XRingingSchedule" minOccurs="1" maxOccurs="7"/> |
diagram | |||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="accessListName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag</xsd:documentation> </xsd:annotation> </xsd:element> |