2.2.4.65 m:ResponseMessageType Complex Type

  • Article

The ResponseMessageType complex type specifies information about the response status for a single entity in a request.

 <xs:complexType name="ResponseMessageType">
   <xs:sequence
     minOccurs="0"
   >
     <xs:element name="MessageText"
       type="xs:string"
       minOccurs="0"
      />
     <xs:element name="ResponseCode"
       type="m:ResponseCodeType"
       minOccurs="0"
      />
     <xs:element name="DescriptiveLinkKey"
       type="xs:int"
       minOccurs="0"
      />
     <xs:element name="MessageXml"
       minOccurs="0"
     >
       <xs:complexType>
         <xs:sequence>
           <xs:any
             process_contents="lax"
             minOccurs="0"
             maxOccurs="unbounded"
            />
         </xs:sequence>
       </xs:complexType>
     </xs:element>
   </xs:sequence>
   <xs:attribute name="ResponseClass"
           type="t:ResponseClassType"
           use="required"
          />
 </xs:complexType>
 

The following table lists the child elements of the ResponseMessageType  complex type.

Element name

Type

Description

MessageText

xs:string ([XMLSCHEMA2])

Specifies a text description of the status of a response.

ResponseCode

m:ResponseCodeType (section 2.2.5.24)

Specifies the error code that identifies the specific error that the request encountered, if any.

DescriptiveLinkKey

xs:int ([XMLSCHEMA2])

This element is not used.

MessageXml

N/A

Specifies additional error response information.

Attributes

Attribute name

Type

Description

ResponseClass

t:ResponseClassType (section 2.2.5.23)

Represents the status of the response. The following values are valid for this attribute:

  • Success

  • Warning

  • Error

This attribute MUST be present.