complexType DoAuthenticateUserRes
diagram AXLSoap_p2528.png
namespace http://www.cisco.com/AXL/API/15.0
type extension of axlapi:APIResponse
properties
base axlapi:APIResponse
children return
used by
element doAuthenticateUserResponse
attributes
Name  Type  Use  Default  Fixed  Annotation
sequence  xsd:unsignedLong  optional      
source <xsd:complexType name="DoAuthenticateUserRes">
 
<xsd:complexContent>
   
<xsd:extension base="axlapi:APIResponse">
     
<xsd:sequence>
       
<xsd:element name="return">
         
<xsd:complexType>
           
<xsd:sequence>
             
<xsd:element name="userAuthenticated" type="axlapi:boolean">
               
<xsd:annotation>
                 
<xsd:documentation>true indicates that user was authenticated and false indicates that user was not authenticated.</xsd:documentation>
               
</xsd:annotation>
             
</xsd:element>
             
<xsd:element name="code" type="xsd:integer">
               
<xsd:annotation>
                 
<xsd:documentation>This is the IMS result code that will be returned.</xsd:documentation>
               
</xsd:annotation>
             
</xsd:element>
             
<xsd:element name="daysToExpiry" type="xsd:integer" minOccurs="0">
               
<xsd:annotation>
                 
<xsd:documentation>This is the number of days remaining for the credential to expire
</xsd:documentation>
               
</xsd:annotation>
             
</xsd:element>
             
<xsd:element name="isWarningNeeded" type="axlapi:boolean" minOccurs="0">
               
<xsd:annotation>
                 
<xsd:documentation>This gives warning about change of credentials before expiry date
</xsd:documentation>
               
</xsd:annotation>
             
</xsd:element>
           
</xsd:sequence>
         
</xsd:complexType>
       
</xsd:element>
     
</xsd:sequence>
   
</xsd:extension>
 
</xsd:complexContent>
</xsd:complexType>

element DoAuthenticateUserRes/return
diagram AXLSoap_p2529.png
properties
content complex
children userAuthenticated code daysToExpiry isWarningNeeded
source <xsd:element name="return">
 
<xsd:complexType>
   
<xsd:sequence>
     
<xsd:element name="userAuthenticated" type="axlapi:boolean">
       
<xsd:annotation>
         
<xsd:documentation>true indicates that user was authenticated and false indicates that user was not authenticated.</xsd:documentation>
       
</xsd:annotation>
     
</xsd:element>
     
<xsd:element name="code" type="xsd:integer">
       
<xsd:annotation>
         
<xsd:documentation>This is the IMS result code that will be returned.</xsd:documentation>
       
</xsd:annotation>
     
</xsd:element>
     
<xsd:element name="daysToExpiry" type="xsd:integer" minOccurs="0">
       
<xsd:annotation>
         
<xsd:documentation>This is the number of days remaining for the credential to expire
</xsd:documentation>
       
</xsd:annotation>
     
</xsd:element>
     
<xsd:element name="isWarningNeeded" type="axlapi:boolean" minOccurs="0">
       
<xsd:annotation>
         
<xsd:documentation>This gives warning about change of credentials before expiry date
</xsd:documentation>
       
</xsd:annotation>
     
</xsd:element>
   
</xsd:sequence>
 
</xsd:complexType>
</xsd:element>

element DoAuthenticateUserRes/return/userAuthenticated
diagram AXLSoap_p2530.png
type axlapi:boolean
properties
content simple
facets
Kind Value Annotation
pattern (t)|(f)|(true)|(false)|(0)|(1)
annotation
documentation
true indicates that user was authenticated and false indicates that user was not authenticated.
source <xsd:element name="userAuthenticated" type="axlapi:boolean">
 
<xsd:annotation>
   
<xsd:documentation>true indicates that user was authenticated and false indicates that user was not authenticated.</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element DoAuthenticateUserRes/return/code
diagram AXLSoap_p2531.png
type xsd:integer
properties
content simple
annotation
documentation
This is the IMS result code that will be returned.
source <xsd:element name="code" type="xsd:integer">
 
<xsd:annotation>
   
<xsd:documentation>This is the IMS result code that will be returned.</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element DoAuthenticateUserRes/return/daysToExpiry
diagram AXLSoap_p2532.png
type xsd:integer
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
This is the number of days remaining for the credential to expire
source <xsd:element name="daysToExpiry" type="xsd:integer" minOccurs="0">
 
<xsd:annotation>
   
<xsd:documentation>This is the number of days remaining for the credential to expire
</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element DoAuthenticateUserRes/return/isWarningNeeded
diagram AXLSoap_p2533.png
type axlapi:boolean
properties
minOcc 0
maxOcc 1
content simple
facets
Kind Value Annotation
pattern (t)|(f)|(true)|(false)|(0)|(1)
annotation
documentation
This gives warning about change of credentials before expiry date
source <xsd:element name="isWarningNeeded" type="axlapi:boolean" minOccurs="0">
 
<xsd:annotation>
   
<xsd:documentation>This gives warning about change of credentials before expiry date
</xsd:documentation>
 
</xsd:annotation>
</xsd:element>


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy