Share via

3.1.4.15 GetHealthScore

  • Article

This operation is used to return information about the health of the protocol server.

The following is the WSDL port type specification of the GetHealthScore WSDL operation.

 <wsdl:operation name="GetHealthScore" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetHealthScore" message="tns:ExcelServiceSoap_GetHealthScore_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetHealthScoreResponse" message="tns:ExcelServiceSoap_GetHealthScore_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetHealthScoreExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_GetHealthScore_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_GetHealthScore_InputMessage, and the protocol server responds with an ExcelServiceSoap_GetHealthScore_OutputMessage, as follows:

  • The CommandResult returned by the protocol server MUST contain ServerHealthInformation as specified in sections 2.2.4.21 and 2.2.4.34.

In the event of an application error on the protocol server during this operation, a SOAP fault is returned, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<24> be one of the values specified in section 2.2.2.1.