3.1.4.8 ConnectAndGetPivotFilterItemList

This operation is used to return the PivotTable members that are part of a PivotTable manual filter hierarchy.

 <wsdl:operation name="ConnectAndGetPivotFilterItemList">
     <wsdl:input message="ConnectAndGetPivotFilterItemListSoapIn" />
     <wsdl:output message="ConnectAndGetPivotFilterItemListSoapOut" />
 </wsdl:operation>

The protocol client sends a ConnectAndGetPivotFilterItemListSoapIn request message, and the protocol server responds with a ConnectAndGetPivotFilterItemListSoapOut response message, as follows:

  1. The protocol client sends the information identifying the PivotTable manual filter in the pivotFilterOptions element.

  2. The protocol server returns the hierarchy of PivotTable members in itemList. The PivotFilterItems element of itemList MUST contain the list (2) of all the PivotTable members at the top hierarchy level of the PivotTable manual filter if there are no more than 1000 such PivotTable members, and MUST contain the first 1000 such PivotTable members if there are more than 1000 such PivotTable members. The ItemListMaxExceeded element of itemList MUST be set to true if there are more than 1000 PivotTable members at the top hierarchy level of the PivotTable manual filter and MUST be set to false otherwise.

In the event of an application error on the protocol server during this operation, the protocol server MUST return an ExcelServerMessage as specified in section 2.2.9.2. The id element of the ExcelServerMessage MUST be one of the values specified in section 2.2.9.4, and SHOULD<16> be one of the following values described in the following table.

Id

Description

InvalidOrTimedOutSession

See section 2.2.9.5.

RetryError

See section 2.2.9.5.

OperationCanceled

See section 2.2.9.5.

InternalError

See section 2.2.9.5.

MultipleRequestsOnSession

See section 2.2.9.5.

MaxRequestDurationExceeded

See section 2.2.9.5.