Share via

3.1.4.13 GetRangeA1

  • Article

This operation is used to retrieve the contents of a named range in the workbook.

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

 <wsdl:operation name="GetRangeA1" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input message="tns:GetRangeA1SoapIn"/>
   <wsdl:output message="tns:GetRangeA1SoapOut"/>
 </wsdl:operation>

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

  • The rangeName specifies the named range of the cells on the sheet (2) to retrieve. The sheet (2) that contains the sheet (2) cells to retrieve is determined in the following manner:

  • If rangeName specifies a sheet (2), that is the sheet (2) that 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<7> use any sheet (2) in the workbook.

  • Each element inside the GetRangeA1Result element MUST be of type ArrayOfAnyType. Each element inside the GetRangeA1Result is a row of sheet (1) cells returned from the protocol server. The number of rows MUST be equal to the rows in the named range specified by rangeName.

  • Each element inside each of the ArrayOfAnyType type nested inside GetRangeA1Result MUST be a single workbook sheet (2) cell. The number of elements inside each such nested ArrayOfAnyType MUST be equal to the number of columns in the named range specified by rangeName.

  • If formatted is false, all sheet (2) cells returned as part of the GetRangeA1Result element MUST either be empty and have the xsi:nil attribute set to true or be one of the following types: Boolean, double, string, or CellError (section 2.2.5.1).

  • If formatted is true, all sheet (2) cells returned as part of the GetRangeA1Result element MUST be type string, and MUST be number formatted according to how the sheet (2) cell is number formatted in the workbook.

  • 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