2.2.4.9 ServiceError

  • Article

Namespace: http://schemas.microsoft.com/server/broadcast/2010/main

A complex type that specifies error information returned by the protocol server to a protocol client.

 <xs:complexType name="ServiceError" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="Message" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Title" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Type" type="tns:ServiceErrorType"/>
     <xs:element minOccurs="1" maxOccurs="1" name="RecommendedActions" type="tns:ClientActions"/>
   </xs:sequence>
 </xs:complexType>

Message: An xs:string ([XMLSCHEMA2/2] section 3.2.1) element that specifies the error message description. The string length MUST be greater than zero if the Type element has a value of "ApplicationError". This element MUST be present.

Title: An xs:string ([XMLSCHEMA2/2] section 3.2.1) element that specifies the error title. The string length MUST be greater than zero if the Type element has a value of "ApplicationError". This element MUST be present.

Type:  A ServiceErrorType (section 2.2.5.7) element that specifies the error type. This element MUST be present.

RecommendedActions:  Reserved and MUST be ignored.