topic Re: few get APIs respond with error in Management

few get APIs respond with error

snikamvyopta — Wed, 15 Oct 2014 21:00:35 GMT

What do we actually specify for a name or uuid values under SerachCriteria in the API request? (where "name" had application user name)

Is there any documentation which explains what are required things in SearchCriteria for each API?

I have only schema link reference- which does not explain it clearly. (https://developer.cisco.com/media/axl-schema-10-0/AXLSoap.html)

Following is a response I am getting for getDialPlan, getGeoLocation, getLicenseCapabilities, getPhysicalLocation.

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

<soapenv:Body>

<soapenv:Fault>

<faultcode>soapenv:Server</faultcode>

<faultstring>Item not valid: The specified vyopta was not found</faultstring>

<axlmessage>Item not valid: The specified vyopta was not found</axlmessage>

<request>getDialPlan</request>

</axlError>

</detail>

</soapenv:Fault>

</soapenv:Body>

</soapenv:Envelope>

Re: few get APIs respond with error

npetrele — Wed, 15 Oct 2014 22:02:59 GMT

Try listDialPlan, etc. to see samples of what getDialPlan, etc. expects. For example the following listDialPlan (the % in the search criteria for name is a wild card and will return all dial plans):

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

<soapenv:Header/>

<soapenv:Body>

<ns:listDialPlan>

</searchCriteria>

</returnedTags>

</ns:listDialPlan>

</soapenv:Body>

</soapenv:Envelope>

Returns something like this:

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

<soap:Body>

<ns2:listDialPlanResponse xmlns:ns2="http://www.cisco.com/AXL/API/10.0">

<name>DialPlanName</name>

<description>DialPlanDescription</description>

</dialPlan>

</return>

</ns2:listDialPlanResponse>

</soap:Body>

</soap:Envelope>

Re: few get APIs respond with error

snikamvyopta — Wed, 15 Oct 2014 22:27:23 GMT

Nicholas,

For ListDialPlan, your solution worked.

But when I tried using listGeoLocation, listLicenseCapabilities, listPhysicalLocation instead of getGeoLocation, getLicenseCapabilities, getPhysicalLocation.

I am still getting following response for all of the above:

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

<soapenv:Body>

<soapenv:Fault>

<faultcode>soapenv:Server</faultcode>

<faultstring>Invalid integer value:</faultstring>

<axlmessage>Invalid integer value:</axlmessage>

<request>listGeoLocation</request>

</axlError>

</detail>

</soapenv:Fault>

</soapenv:Body>

</soapenv:Envelope>

Re: few get APIs respond with error

dstaudt — Wed, 15 Oct 2014 22:47:42 GMT

You might check that you are not including '?' or something else invalid in the 'sequence' attribute. I seem to recall that the listXXX requests may be more strict in checking for an invalid sequence value, while other requests (like getXXX) complain...

Re: few get APIs respond with error

npetrele — Thu, 16 Oct 2014 14:17:25 GMT

This listGeoLocation worked fine for me...

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

<soapenv:Header/>

<soapenv:Body>

<ns:listGeoLocation>

</searchCriteria>

</returnedTags>

</ns:listGeoLocation>

</soapenv:Body>

</soapenv:Envelope>

Why don't you post some of your AXL requests that are failing? Perhaps we can detect a syntax problem or something.

Re: few get APIs respond with error

snikamvyopta — Thu, 16 Oct 2014 14:41:36 GMT

Hi Nicholas,

Following is a request for listGeoLocation that did not work and was throwing -1 error code in response:

The reason I found is that, it does not like empty <skip/> and <first/> tags after <returnedTags /> in the request. When I removed those 2 tags completely, I get a success response.

I am using SoapUI tool, and the wsdl file I have included for 9.1 schema has these two tags mentioned above, for almost every API request template.

<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:listGeoLocation>

</searchCriteria>

<name/>

</returnedTags>

</ns:listGeoLocation>

</soapenv:Body>

</soapenv:Envelope>

Re: few get APIs respond with error

npetrele — Thu, 16 Oct 2014 15:16:21 GMT

At the risk of sounding snarky, if it doesn't work with skip and first, then don't use skip and first!

Seriously, skip and first are optional, but skip and first will work if you give them values. Skip = how many matches you want to skip before returning data, First = return the first X matches after skipping.

For example, the following modification to your example works fine.

<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:listGeoLocation>

</searchCriteria>

<name/>

</returnedTags>

</ns:listGeoLocation>

</soapenv:Body>

</soapenv:Envelope>

Re: few get APIs respond with error

snikamvyopta — Thu, 16 Oct 2014 15:49:16 GMT

Hi Nicholas,

Sure, I can simply skip those 2 tags, I believe getting all the records in our case won't cause much overhead on response.

However, we might need it as controlling parameters for big queries.

Re: few get APIs respond with error

npetrele — Thu, 16 Oct 2014 17:49:57 GMT

"However, we might need it as controlling parameters for big queries."

That's when you can use the skip and first tags to limit what's returned. Just make sure they're not empty.

Re: few get APIs respond with error

snikamvyopta — Thu, 16 Oct 2014 17:53:56 GMT

Of course!