Share via

3.1.4.9 GetCellA1

  • Article

This operation is used to retrieve the contents of a specific cell in the workbook.

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

 <wsdl:operation name="GetCellA1" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input message="tns:GetCellA1SoapIn"/>
   <wsdl:output message="tns:GetCellA1SoapOut"/>
 </wsdl:operation>

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

1. The rangeName specifies the location of the sheet (2) cell to retrieve. The sheet (2) that contains the sheet (2) cell to retrieve is determined in the following manner.

  • If rangeName specifies a sheet (2), that is the sheet (2) which MUST be used.

  • Otherwise, the sheet (2) specified in sheetName MUST be used, as specified in section 2.2.5.4.

  • If neither sheetName nor rangeName specify a sheet (2), the protocol server MAY<6> use any sheet (1) in the workbook.

2. If formatted is false, the sheet (2) cell returned as the GetCellA1Result element MUST be either not present or one of the following types: boolean, double, string, or CellError (section 2.2.5.1).

3. If formatted is true, the sheet (2) cell returned as the GetCellA1Result element MUST be type string, and MUST be number formatted according to how the sheet (2) cell is number formatted in the workbook.

4. If there was an application error on the protocol server during the operation, the protocol server MUST return a SOAP fault response, which SHOULD contain one of the following subcodes or any other subcodes specified in section 2.2.9.2, but MAY instead contain any subcode specified in section 2.2.9.1 or any other subcode.

Subcode

DiscontiguousRangeNotSupported

EcsInvalidNamedObject

InvalidSheetName

RangeDefinitionError

RangeParseError

RangeRequestAreaExceeded

SheetRangeMismatch