cancel
Showing results for 
Search instead for 
Did you mean: 
cancel
1377
Views
5
Helpful
1
Replies

Understanding updateUser AXL Response

Hello everyone!

I'm beginner on AXL, and I'm trying to get more information about it. At this moment, i've installed a lab cucm 11.5 to use in this journey.

I've read the documentation on DevNet (developer.cisco.com/site/axl/) but I'm missing something about the return messages in case of success.

I'm using PostMan to send the following command:

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/11.5">
    <soapenv:Header/>
    <soapenv:Body>
        <ns:updateUser>
            <userid>Test-User1</userid>
            <pin>12345678</pin>
        </ns:updateUser>
    </soapenv:Body>
</soapenv:Envelope>

 

 

The PIN was successfully changed and I have received a 200 OK and the following content:

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:updateUserResponse xmlns:ns="http://www.cisco.com/AXL/API/10.5">
<return>{String_With_UUID_From_My_Test_USER}</return>
</ns:updateUserResponse>
</soapenv:Body>
</soapenv:Envelope>

 

But I don't find information on published docs what is the expected return content of the updateUser request.

(ie: User´s UUID is a expected return of updateUser request)

The DevNet documentation indicates the following:

"In general, AXL responses will display/accept UUIDs surrounded by braces and using alpha characters in uppercase:"
source: https://developer.cisco.com/docs/axl/#!axl-developer-guide/handling-unique-ids

But where I can find what is the expected response from each kind of request?

TY

1 Accepted Solution

Accepted Solutions

dstaudt
Cisco Employee
Cisco Employee

In general the a AXL schema documentation will be the source for this kind of information. 

 

For example, examining the <updateUserResponse> message:

 

https://pubhub.devnetcloud.com/media/axl-schema-reference/docs/Files/AXLSoap_updateUserResponse.html#Link1144

 

we can see that <updateUserResponse> is of type axlapi:StandardResponse, which has a child element <return> of type xsd:string, with a pattren restriction of "(true)|(false)|(\{........-....-....-....-............\})"

 

Many AXL responses re-use the type axlapi:StandardResponse...it looks like it has the possibility of returning 'true' or 'fase', maybe depending on which AXL API is being used.

 

I frequently use soapUI, which can import the AXL WSDL (the original source code of the AXL schema docs themselves) and auto-generate/execute AXL requests - including templates of the XML with all the various options.  You can use this to try out AXL commands and see the actual XML response.

View solution in original post

1 Reply 1

dstaudt
Cisco Employee
Cisco Employee

In general the a AXL schema documentation will be the source for this kind of information. 

 

For example, examining the <updateUserResponse> message:

 

https://pubhub.devnetcloud.com/media/axl-schema-reference/docs/Files/AXLSoap_updateUserResponse.html#Link1144

 

we can see that <updateUserResponse> is of type axlapi:StandardResponse, which has a child element <return> of type xsd:string, with a pattren restriction of "(true)|(false)|(\{........-....-....-....-............\})"

 

Many AXL responses re-use the type axlapi:StandardResponse...it looks like it has the possibility of returning 'true' or 'fase', maybe depending on which AXL API is being used.

 

I frequently use soapUI, which can import the AXL WSDL (the original source code of the AXL schema docs themselves) and auto-generate/execute AXL requests - including templates of the XML with all the various options.  You can use this to try out AXL commands and see the actual XML response.