2.2.9.3 Detail Node XML Document

  • Article

In the event of an application error, the protocol server sets the alert in the soap fault detail in the form of an XML document. The elements in the XML document MUST NOT have an XML namespace. The XML document MUST conform to the following XML schema.

 <s:complexType name="ExcelServerMessage">
    <s:sequence>
       <s:element minOccurs="1" maxOccurs="1" name="HasOpenItemPermission" type="s:boolean" />
      <s:element minOccurs="1" maxOccurs="1" name="Id" type="s:string" />
      <s:element minOccurs="1" maxOccurs="1" name="Severity" type="MessageSeverity" />
      <s:element minOccurs="1" maxOccurs="1" name="Type" type="MessageType" />
      <s:element minOccurs="1" maxOccurs="1" name="Buttons" type="MessageButtons" />
      <s:element minOccurs="1" maxOccurs="1" name="Description" type="s:string" />
      <s:element minOccurs="1" maxOccurs="1" name="ExtendedDescription" type="s:string" />
      <s:element minOccurs="1" maxOccurs="1" name="Caption" type="s:string" />
      <s:element minOccurs="0" maxOccurs="1" name="HelpTopicId" type="s:string" />
      <s:element minOccurs="1" maxOccurs="1" name="HelpDisplayText" type="s:string" />
    </s:sequence>
 </s:complexType>

HasOpenItemPermission: Specifies whether the user has Open Item permission to the workbook file.

Id: The identifier of the alert. MUST be one of the identifiers specified in section 2.2.9.4.

Severity: The severity of the alert as specified in section 2.2.9.1.2.

Type: The type of the alert as specified in section 2.2.9.1.3.

Buttons: The control buttons associated with the alert as specified in section 2.2.9.1.1.

Description: A text description of the alert. MUST NOT be empty. The text MUST be in the language UI culture of the session (2).

ExtendedDescription: An extended description of the alert. MUST be in the language UI culture of the session (2).

Caption: A caption for the alert. MUST be in the language UI culture of the session (2).

HelpTopicId: The Help topic identifier.

HelpDisplayText: A description of the help topic. MUST be in the language UI culture of the session (2).