API Home >> Sheet >> API Reference >> content

Get the entire content of a particular workbook.

Request URL :

                                XML : http://sheet.zoho.com/api/private/xml/content/[BookID]?apikey=[API Key]&ticket=[Ticket]

                                JSON : http://sheet.zoho.com/api/private/json/content/[BookID]?apikey=[API Key]&ticket=[Ticket]

Response fields

The schema document for the API response is located at: http://sheet.zoho.com/schema/bookcontent.xsd

Field	Description
sheetContent	Gets the entire content of a workbook. Multiple sheets are identified with their index parameter. Other parameters include name, rows and cols.
row	Identifies a particular row with the index number and subsequent cell values in that row.
cell	Gets content of each cell specific to each cell index. Other parameter may include dataType, value, formula etc.

Sample Response

The following is the sample response for the above method:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/content/15265000000006067">
  <result>
    <workbookContent>
      <sheetContent index="1" name="Temperature Converter" rows="12" cols="4">
        <row index="4">
            <cell index="2" dataType="string">Temperature Converter</cell>
        </row>
        <row index="6">
            <cell index="2" dataType="string">Enter Celsius degree here ==></cell>
            <cell index="3" dataType="float" value="0">0</cell>
            <cell index="4" dataType="string">°C</cell>
        </row>
        <row index="7">
            <cell index="2" dataType="string">Fahrenheit degree will be ==></cell>
            <cell index="3" formula="=(C6*1.8+32)" dataType="float" value="32">32</cell>
            <cell index="4" dataType="string">°F</cell>
        </row>
        <row index="8">
            <cell index="2" dataType="string">Kelvin degree will be ==></cell>
            <cell index="3" formula="=(C6+273.15)" dataType="float" value="273.15">273.15</cell>
            <cell index="4" dataType="string">°K</cell>
        </row>
      </sheetContent>
    </workbookContent>
  </result>
</response>

Equivalent JSON response

{
  "response":
   {
        "uri": "/api/private/json/content/15265000000006067",
        "result":
        {
           "workbookContent":
            {
                "sheetContent":
                [
                    {
                        "index":"1",
                        "name":"Temperature Converter",
                        "rows":"12",
                        "cols":"4",
                        
                        "row":
                       
                        [
                         {"index":"4",
                          "cell":
                          [{"index":"2","dataType":"string","_content":"Temperature Converter"}]
                         },
                       
                         {"index":"6",
                          "cell":
                          [
                           {"index":"2","dataType":"string","_content":"Enter Celsius degree here ==>"},
                           {"index":"3","dataType":"float","value":"0","_content":"0"},
                           {"index":"4","dataType":"string","_content":"°C"}
                          ]
                         },
                        
                         {"index":"7",
                          "cell":
                          [
                           {"index":"2","dataType":"string","_content":"Fahrenheit degree will be"},
                           {"index":"3","formula": =(C6*1.8+32)","dataType":"float",value="32", "_content":"32"},
                           {"index":"4","dataType":"string","_content":"°F"}
                          ]
                         },
                         {"index":"8",
                          "cell":
                          [
                           {"index":"2","dataType":"string","_content":"Kelvin degree will be"},
                           {"index":"3","formula":=(C6+273.15)","dataType":"float","value":"273.15", "_content":"273.15"},
                           {"index":"4","dataType":"string","_content":"°K"}
                          ]
                         },

                       ]
                    }                  
                 ]
             }
         }
    }
}  
 

Errors

Displaying entire content of a private workbook may return general errors. Other specific HTTP error codes include 2851 and 2853.