Product Documentation

    The following example defines the TR31Response type:

    #

    TR31Response XML Content

    1

    		 
    <xs:complexType name="tr31Response">

    2

    		 
    <xs:sequence>

    3

    		 
    <xs:element name="respMsgCode" type="xs:string" minOccurs="0"/>

    4

    		 
    <xs:element name="respMessage" type="xs:string" minOccurs="0"/>

    5

    		 
    <xs:element name="respErrCode" type="xs:string" minOccurs="0"/>

    6

    		 
    <xs:element name="respError" type="xs:string" minOccurs="0"/>

    7

    		 
    <xs:element name="respObject" type="xs:anyType" minOccurs="0"/>

    8

    		 
    <xs:element name="respObjType" type="tns:tr31RESPONSEOBJECTTYPE" minOccurs="0"/>

    9

    		 
    </xs:sequence>

    10

    		 
    </xs:complexType>

     

    The following table explains each line of the above XML file:

    #

    TR31Response XML Content Explanation

    1

    The start of the TR31Response element.

    2

    The start of a sequence.

    3

    The respMsgCode element—a message code used by the appliance as a reference. Response message codes of the format 'TR31-MSG-NNNN' indicate a success (where NNNN are numerals). This value may be empty in the event of a webservice failure.

    4

    The respMessage element—a message which describes a success condition. This value may be empty in the event of a webservice failure.

    5

    The respErrCode element—a message code used by the appliance as a reference. Response message codes of the format 'TR31-ERR-NNNN' indicate a failure (where NNNN are numerals). This value may be empty in the event of a webservice success.

    6

    The respError element—an error message which describes a failure condition. This value may be empty in the event of a webservice success.

    7

    		 The respObject element—a java object that depending on the operation may be returned to the calling application. This value may be empty in the event of a webservice failure.

    8

    The respObjType element—a constant that describes the variable type of the respObject element, if one is returned. This value may be empty in the event of a webservice failure.

    9

    The end of the sequence.

    10

    The end of the TR31Response.