3.1.4.81 EnsureWorkbookModel

  • Article

Loads a workbook data model and returns information about the model.

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

 <wsdl:operation name="EnsureWorkbookModel" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/EnsureWorkbookModel" message="tns:ExcelServiceSoap_EnsureWorkbookModel_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/EnsureWorkbookModelResponse" message="tns:ExcelServiceSoap_EnsureWorkbookModel_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/EnsureWorkbookModelExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_EnsureWorkbookModel_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_EnsureWorkbookModel_InputMessage request message, and the protocol server responds with an ExcelServiceSoap_EnsureWorkbookModel_OutputMessage response message, as follows:

  1. The protocol server loads the workbook data model and returns information about the data model in the dataSource, catalog, sessionTimeout and version elements in EnsureWorkbookModelResponse.

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<96> be one of the values specified in section 2.2.2.1.