3.1.4.13 GetPivotFilterItemList

This operation is used to return child PivotTable members that are part of a PivotTable manual filter hierarchy. This operation is used after calling ConnectAndGetPivotFilterItemList (section 3.1.4.8) or after calling GetPivotFilterItemList for an ancestor in the hierarchy.

 <wsdl:operation name="GetPivotFilterItemList">
     <wsdl:input message="GetPivotFilterItemListSoapIn" />
     <wsdl:output message="GetPivotFilterItemListSoapOut" />
 </wsdl:operation>

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

1. The protocol client sends the following information in the pivotFilterOptions element:

   • The PivotTable manual filter.

   • The PivotTable member that is the common ancestor of all the PivotTable members in the hierarchy to be returned.

2. The protocol server returns the PivotTable members in itemList. The PivotFilterItems element of itemList MUST contain the list (2) of all the PivotTable members that are children of the PivotTable member that has an Id that is equal to the ParentId element of pivotFilterOptions 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 the PivotTable member who has an Id that is equal to the ParentId element of pivotFilterOptions has more than 1000 children PivotTable members 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<21> be one of the following values.

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.