Generating lists via AXL (API/9.1)

[Petr Kriz]

Hello,
I try to have a few days to find, how I can read through AXL list of all devices (phones) and their associated lines. Can you please help?

System version: 9.1.2.10000-28

Used AXL WSDL version: http://www.cisco.com/AXL/API/9.1

The only method what I found on websites is through SQL, but I want use Cisco recommended action through AXL.

Note, if I run SQL like this (see below), I get devices what i want (but later I must find in next N sql queries lines etc.). I don't want to go through SQL queries, but I want to obtain lists of partition, CSS, PhoneTypes etc. through the AXL interface.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/9.1">

   <soapenv:Header/>

   <soapenv:Body>

      <ns:executeSQLQuery sequence="?">

         <sql>select d.name,d.description,dmap.numplanindex, n.dnorpattern

           from device as d

           inner join devicenumplanmap as dmap on dmap.fkdevice=d.pkid

           inner join numplan as n on dmap.fknumplan = n.pkid</sql>

      </ns:executeSQLQuery>

   </soapenv:Body>

</soapenv:Envelope>

Thank you and best regards,

Peter

[tinghche]

Peter,

You can try using listPhone.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/8.5">

   <soapenv:Header/>

   <soapenv:Body>

      <ns:listPhone sequence="?">

         <searchCriteria>

               <name>%</name>

          </searchCriteria>

          <returnedTags>

               <name/>

               <model/>

               <callingSearchSpaceName/>

          </returnedTags>

      </ns:listPhone>

   </soapenv:Body>

</soapenv:Envelope>

You can refer to  listPhone API for more details

https://developer.cisco.com/media/axl-schema-10-0/AXLSoap_ListPhoneReq.html

[Petr Kriz]

Hello Chen,

I tried the method listPhone (and others listSomething methods), but it seems that these methods are not fully functional (or I am  doing something explicitly wrong). I am running tests in application: SoapUI 4.6.4.

1. When I modify your code, it works fine (but I don't see CSS):

Input:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/9.1">

   <soapenv:Header/>

   <soapenv:Body>

      <ns:listPhone sequence="?">

         <searchCriteria>

               <name>%</name>

          </searchCriteria>

          <returnedTags>

               <name/>

               <model/>

               <callingSearchSpaceName uuid="?"></callingSearchSpaceName>

               <emccCallingSearchSpaceName uuid="?"></emccCallingSearchSpaceName>

               <phoneTemplateName uuid="?"></phoneTemplateName>

               <subscribeCallingSearchSpaceName uuid="?"></subscribeCallingSearchSpaceName>

               <rerouteCallingSearchSpaceName uuid="?"></rerouteCallingSearchSpaceName>

          </returnedTags>

      </ns:listPhone>

   </soapenv:Body>

</soapenv:Envelope>

Output:

...

            <phone uuid="{SOME-UUID}">

               <name>SEP001E5E92112C</name>

               <model>Cisco 7965</model>

               <callingSearchSpaceName/>

               <phoneTemplateName uuid="{SOME-UUID}">Standard 7965 SCCP</phoneTemplateName>

               <subscribeCallingSearchSpaceName/>

               <rerouteCallingSearchSpaceName/>

            </phone>

...

2. If I want see all methods what returns, I run generated code from WSDL - no success (I tried many combinations):

Input:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/9.1">

   <soapenv:Header/>

   <soapenv:Body>

      <ns:listPhone sequence="?">

         <searchCriteria>

            <!--Optional:-->

            <name>?</name>

            <!--Optional:-->

            <description>?</description>

            <!--Optional:-->

            <protocol>?</protocol>

            <!--Optional:-->

            <callingSearchSpaceName>?</callingSearchSpaceName>

            <!--Optional:-->

            <devicePoolName>?</devicePoolName>

            <!--Optional:-->

            <securityProfileName>?</securityProfileName>

         </searchCriteria>

         <returnedTags ctiid="?" uuid="?">

            <!--Optional:-->

            <name>?</name>

            <!--Optional:-->

            <description>?</description>

            <!--Optional:-->

            <product>?</product>

            <!--Optional:-->

            <model>?</model>

            <!--Optional:-->

            <class>?</class>

            <!--Optional:-->

            <protocol>?</protocol>

            <!--Optional:-->

            <protocolSide>?</protocolSide>

            <!--Optional:-->

            <callingSearchSpaceName uuid="?">?</callingSearchSpaceName>

            <!--Optional:-->

            <devicePoolName uuid="?">?</devicePoolName>

            <!--Optional:-->

            <commonDeviceConfigName uuid="?">?</commonDeviceConfigName>

            <!--Optional:-->

            <commonPhoneConfigName uuid="?">?</commonPhoneConfigName>

            <!--Optional:-->

            <networkLocation>?</networkLocation>

            <!--Optional:-->

            <locationName uuid="?">?</locationName>

            <!--Optional:-->

            <mediaResourceListName uuid="?">?</mediaResourceListName>

            <!--Optional:-->

            <networkHoldMohAudioSourceId>?</networkHoldMohAudioSourceId>

            <!--Optional:-->

            <userHoldMohAudioSourceId>?</userHoldMohAudioSourceId>

            <!--Optional:-->

            <automatedAlternateRoutingCssName uuid="?">?</automatedAlternateRoutingCssName>

            <!--Optional:-->

            <aarNeighborhoodName uuid="?">?</aarNeighborhoodName>

            <!--Optional:-->

            <loadInformation special="?">?</loadInformation>

            <!--Optional:-->

            <traceFlag>?</traceFlag>

            <!--Optional:-->

            <mlppIndicationStatus>?</mlppIndicationStatus>

            <!--Optional:-->

            <preemption>?</preemption>

            <!--Optional:-->

            <useTrustedRelayPoint>?</useTrustedRelayPoint>

            <!--Optional:-->

            <retryVideoCallAsAudio>?</retryVideoCallAsAudio>

            <!--Optional:-->

            <securityProfileName uuid="?">?</securityProfileName>

            <!--Optional:-->

            <sipProfileName uuid="?">?</sipProfileName>

            <!--Optional:-->

            <cgpnTransformationCssName uuid="?">?</cgpnTransformationCssName>

            <!--Optional:-->

            <useDevicePoolCgpnTransformCss>?</useDevicePoolCgpnTransformCss>

            <!--Optional:-->

            <geoLocationName uuid="?">?</geoLocationName>

            <!--Optional:-->

            <geoLocationFilterName uuid="?">?</geoLocationFilterName>

            <!--Optional:-->

            <sendGeoLocation>?</sendGeoLocation>

            <!--Optional:-->

            <numberOfButtons>?</numberOfButtons>

            <!--Optional:-->

            <phoneTemplateName uuid="?">?</phoneTemplateName>

            <!--Optional:-->

            <primaryPhoneName uuid="?">?</primaryPhoneName>

            <!--Optional:-->

            <ringSettingIdleBlfAudibleAlert>?</ringSettingIdleBlfAudibleAlert>

            <!--Optional:-->

            <ringSettingBusyBlfAudibleAlert>?</ringSettingBusyBlfAudibleAlert>

            <!--Optional:-->

            <userLocale>?</userLocale>

            <!--Optional:-->

            <networkLocale>?</networkLocale>

            <!--Optional:-->

            <idleTimeout>?</idleTimeout>

            <!--Optional:-->

            <authenticationUrl>?</authenticationUrl>

            <!--Optional:-->

            <directoryUrl>?</directoryUrl>

            <!--Optional:-->

            <idleUrl>?</idleUrl>

            <!--Optional:-->

            <informationUrl>?</informationUrl>

            <!--Optional:-->

            <messagesUrl>?</messagesUrl>

            <!--Optional:-->

            <proxyServerUrl>?</proxyServerUrl>

            <!--Optional:-->

            <servicesUrl>?</servicesUrl>

            <!--Optional:-->

            <softkeyTemplateName uuid="?">?</softkeyTemplateName>

            <!--Optional:-->

            <loginUserId>?</loginUserId>

            <!--Optional:-->

            <defaultProfileName uuid="?">?</defaultProfileName>

            <!--Optional:-->

            <enableExtensionMobility>?</enableExtensionMobility>

            <!--Optional:-->

            <currentProfileName uuid="?">?</currentProfileName>

            <!--Optional:-->

            <loginTime>?</loginTime>

            <!--Optional:-->

            <loginDuration>?</loginDuration>

            <!--Optional:-->

            <currentConfig>

               <!--Optional:-->

               <userHoldMohAudioSourceId>?</userHoldMohAudioSourceId>

               <!--Optional:-->

               <phoneTemplateName uuid="?">?</phoneTemplateName>

               <!--Optional:-->

               <mlppDomainId>?</mlppDomainId>

               <!--Optional:-->

               <mlppIndicationStatus>?</mlppIndicationStatus>

               <!--Optional:-->

               <preemption>?</preemption>

               <!--Optional:-->

               <softkeyTemplateName uuid="?">?</softkeyTemplateName>

               <!--Optional:-->

               <ignorePresentationIndicators>?</ignorePresentationIndicators>

               <!--Optional:-->

               <singleButtonBarge>?</singleButtonBarge>

               <!--Optional:-->

               <joinAcrossLines>?</joinAcrossLines>

               <!--Optional:-->

               <callInfoPrivacyStatus>?</callInfoPrivacyStatus>

               <!--Optional:-->

               <dndStatus>?</dndStatus>

               <!--Optional:-->

               <dndRingSetting>?</dndRingSetting>

               <!--Optional:-->

               <dndOption>?</dndOption>

               <!--Optional:-->

               <alwaysUsePrimeLine>?</alwaysUsePrimeLine>

               <!--Optional:-->

               <alwaysUsePrimeLineForVoiceMessage>?</alwaysUsePrimeLineForVoiceMessage>

               <!--Optional:-->

               <emccCallingSearchSpaceName uuid="?">?</emccCallingSearchSpaceName>

               <!--Optional:-->

               <deviceName>?</deviceName>

               <!--Optional:-->

               <model>?</model>

               <!--Optional:-->

               <product>?</product>

               <!--Optional:-->

               <deviceProtocol>?</deviceProtocol>

               <!--Optional:-->

               <class>?</class>

               <!--Optional:-->

               <addressMode>?</addressMode>

               <!--Optional:-->

               <allowAutoConfig>?</allowAutoConfig>

               <!--Optional:-->

               <remoteSrstOption>?</remoteSrstOption>

               <!--Optional:-->

               <remoteSrstIp>?</remoteSrstIp>

               <!--Optional:-->

               <remoteSrstPort>?</remoteSrstPort>

               <!--Optional:-->

               <remoteSipSrstIp>?</remoteSipSrstIp>

               <!--Optional:-->

               <remoteSipSrstPort>?</remoteSipSrstPort>

               <!--Optional:-->

               <geolocationInfo>?</geolocationInfo>

            </currentConfig>

            <!--Optional:-->

            <singleButtonBarge>?</singleButtonBarge>

            <!--Optional:-->

            <joinAcrossLines>?</joinAcrossLines>

            <!--Optional:-->

            <builtInBridgeStatus>?</builtInBridgeStatus>

            <!--Optional:-->

            <callInfoPrivacyStatus>?</callInfoPrivacyStatus>

            <!--Optional:-->

            <hlogStatus>?</hlogStatus>

            <!--Optional:-->

            <ownerUserName uuid="?">?</ownerUserName>

            <!--Optional:-->

            <ignorePresentationIndicators>?</ignorePresentationIndicators>

            <!--Optional:-->

            <packetCaptureMode>?</packetCaptureMode>

            <!--Optional:-->

            <packetCaptureDuration>?</packetCaptureDuration>

            <!--Optional:-->

            <subscribeCallingSearchSpaceName uuid="?">?</subscribeCallingSearchSpaceName>

            <!--Optional:-->

            <rerouteCallingSearchSpaceName uuid="?">?</rerouteCallingSearchSpaceName>

            <!--Optional:-->

            <allowCtiControlFlag>?</allowCtiControlFlag>

            <!--Optional:-->

            <presenceGroupName uuid="?">?</presenceGroupName>

            <!--Optional:-->

            <unattendedPort>?</unattendedPort>

            <!--Optional:-->

            <requireDtmfReception>?</requireDtmfReception>

            <!--Optional:-->

            <rfc2833Disabled>?</rfc2833Disabled>

            <!--Optional:-->

            <certificateOperation>?</certificateOperation>

            <!--Optional:-->

            <authenticationMode>?</authenticationMode>

            <!--Optional:-->

            <keySize>?</keySize>

            <!--Optional:-->

            <authenticationString>?</authenticationString>

            <!--Optional:-->

            <certificateStatus>?</certificateStatus>

            <!--Optional:-->

            <upgradeFinishTime>?</upgradeFinishTime>

            <!--Optional:-->

            <deviceMobilityMode>?</deviceMobilityMode>

            <!--Optional:-->

            <roamingDevicePoolName uuid="?">?</roamingDevicePoolName>

            <!--Optional:-->

            <remoteDevice>?</remoteDevice>

            <!--Optional:-->

            <dndOption>?</dndOption>

            <!--Optional:-->

            <dndRingSetting>?</dndRingSetting>

            <!--Optional:-->

            <dndStatus>?</dndStatus>

            <!--Optional:-->

            <isActive>?</isActive>

            <!--Optional:-->

            <isDualMode>?</isDualMode>

            <!--Optional:-->

            <mobilityUserIdName uuid="?">?</mobilityUserIdName>

            <!--Optional:-->

            <phoneSuite>?</phoneSuite>

            <!--Optional:-->

            <phoneServiceDisplay>?</phoneServiceDisplay>

            <!--Optional:-->

            <isProtected>?</isProtected>

            <!--Optional:-->

            <mobileSmartClientProfileName uuid="?">?</mobileSmartClientProfileName>

            <!--Optional:-->

            <mtpRequired>?</mtpRequired>

            <!--Optional:-->

            <mtpPreferedCodec>?</mtpPreferedCodec>

            <!--Optional:-->

            <dialRulesName uuid="?">?</dialRulesName>

            <!--Optional:-->

            <sshUserId>?</sshUserId>

            <!--Optional:-->

            <digestUser>?</digestUser>

            <!--Optional:-->

            <outboundCallRollover>?</outboundCallRollover>

            <!--Optional:-->

            <hotlineDevice>?</hotlineDevice>

            <!--Optional:-->

            <secureInformationUrl>?</secureInformationUrl>

            <!--Optional:-->

            <secureDirectoryUrl>?</secureDirectoryUrl>

            <!--Optional:-->

            <secureMessageUrl>?</secureMessageUrl>

            <!--Optional:-->

            <secureServicesUrl>?</secureServicesUrl>

            <!--Optional:-->

            <secureAuthenticationUrl>?</secureAuthenticationUrl>

            <!--Optional:-->

            <secureIdleUrl>?</secureIdleUrl>

            <!--Optional:-->

            <alwaysUsePrimeLine>?</alwaysUsePrimeLine>

            <!--Optional:-->

            <alwaysUsePrimeLineForVoiceMessage>?</alwaysUsePrimeLineForVoiceMessage>

            <!--Optional:-->

            <featureControlPolicy uuid="?">?</featureControlPolicy>

            <!--Optional:-->

            <deviceTrustMode>?</deviceTrustMode>

            <!--Optional:-->

            <earlyOfferSupportForVoiceCall>?</earlyOfferSupportForVoiceCall>

            <!--Optional:-->

            <requireThirdPartyRegistration>?</requireThirdPartyRegistration>

            <!--Optional:-->

            <blockIncomingCallsWhenRoaming>?</blockIncomingCallsWhenRoaming>

            <!--Optional:-->

            <homeNetworkId>?</homeNetworkId>

            <!--Optional:-->

            <AllowPresentationSharingUsingBfcp>?</AllowPresentationSharingUsingBfcp>

            <!--Optional:-->

            <requireOffPremiseLocation>?</requireOffPremiseLocation>

            <!--Optional:-->

            <userlocale>?</userlocale>

         </returnedTags>

         <!--Optional:-->

         <skip>?</skip>

         <!--Optional:-->

         <first>?</first>

      </ns:listPhone>

   </soapenv:Body>

</soapenv:Envelope>

Output (I always saw this output)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

   <soapenv:Body>

      <soapenv:Fault>

         <faultcode>soapenv:Server</faultcode>

         <faultstring>Invalid integer value: ?</faultstring>

         <detail>

            <axlError>

               <axlcode>-1</axlcode>

               <axlmessage>Invalid integer value: ?</axlmessage>

               <request>listPhone</request>

            </axlError>

         </detail>

      </soapenv:Fault>

   </soapenv:Body>

</soapenv:Envelope>

Is there any way to find detail bugs why this happens? I tried set AXL Trace Logs (Cisco Unified Communications Manager XML Developers Guide, Release 9.1(1) - Administrative XML API [Cisco Unified Commun…) but I can't see any errors.

Thank you and best regards,

Peter

[tinghche]

Hi Peter,

Have you checked the CSS has indeed been assigned on this particular phone?

I ran it on my lab (10.0 using AXL 9.1) it appears to be working fine.

Howard

[Petr Kriz · Accepted solution]

Hello Chen,

finnaly I found a probably error. If I removed lines (see strong text) all works fine.

         </returnedTags>

         <!--Optional:-->

         <skip>?</skip>

         <!--Optional:-->

         <first>?</first>

      </ns:listPhone>

Thank you and best regards,

Peter