Document Information

This API retrieves document information. It returns an object that contains the document description with meta data and coordinates of text on pages.

DocumentInfo object fields

Field NameTypeDescription
namestringThe document name.
folderstringThe document folder.
extensionstringThe file extension.
fileFormatstringThe file type.
sizelongThe file size.
dateModifiedDateTimeThe file last modification date.
pagesList<PageInfo>The file pages list.

PageInfo object fields

Field NameTypeDescription
numberintThe page number.
widthintThe page width.
heightintThe page height.
visibleboolIf page is visible.
rowsList<RowInfo>The page rows list.

RowInfo object fields

Field NameTypeDescription
characterCoordinatesList<double>Coordinates of row characters.
lineHeightdoubleThe height of the row.
lineLeftdoubleThe left position of the row.
lineTopdoubleThe top position of the row.
linewidthdoubleThe width of the row.
textstringThe row text.
texCoordinatesList<double>The text line coordinates.

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to get document information(Image representation).

cURL REST Example

curl -v "https://api.groupdocs.cloud/v1/annotation/Annotated_docx.docx/image/info" \
-X GET \
-H "Content-Type: application/json" \
-H "authorization: Bearer 0v7TK3UGYjVBEcEIS9aaO0dsXAlt-KriIDnJGkDIPktFmuu6xIuou2-eVUD4-Td9TcToDvShk9w02pWIXvyEdstxDqjSa8L2K4Pk2zgNkAoEDgDeFlpWf0k7lZ8guqUm43eAKQf43MVNyr3L6P3w1e2l9j-RJx-btpPorcZ90xY8S_b1vySsKsUxOlnwYtWc01JEXlO7TNrmfD3Eek4ch-xzi-qe4V8nofmy7RbqwHNczeP7O_9bMi1eQ68b3Rprqd4UvDCj3gqTMyAaqd-I58lJzZsHRnbZoM7icIjVQyu02bRgx7meoXB8fIWmOkUfUkiGTT3IjI4NSmARxrPPwgp2LAv-N_9H0q3nxxfZDV1vHZQP--I6vgC2UHo-YPw-mB4WRVHsUKqq04L4pdR4pCIWuluus_ydjVH_ndJlqP843eL3glt1XJez3DgXQIbHiAnqBBDqZqSZZDVUYhLDq1jN9eM"
{  
   "name":"Annotated_docx.docx",
   "folder":null,
   "extension":"docx",
   "fileFormat":"Docx",
   "size":11590,
   "dateModified":"2017-03-21T14:51:06.8720237Z",
   "pages":[  
      {  
         "number":1,
         "width":612,
         "height":792,
         "visible":false,
         "rows":[  
            {  
               "characterCoordinates":[  
                  85.05,
                  90.099,
                  92.629,
                  96.468,
                  100.769,
                  106.94,
                  112.616,
                  117.885,
                  123.066
               ],
               "lineHeight":12.1,
               "lineLeft":85.05,
               "lineTop":58.033,
               "lineWidth":43.494,
               "text":"First Page",
               "textCoordinates":[  
                  85.05,
                  19.404,
                  106.94,
                  21.604
               ]
            }
         ]
      },
      {  
         "number":2,
         "width":612,
         "height":792,
         "visible":false,
         "rows":[  
            {  
               "characterCoordinates":[  
                  85.05,
                  90.099,
                  95.577,
                  100.23,
                  106.027,
                  111.813,
                  120.074,
                  125.849,
                  131.118,
                  136.299
               ],
               "lineHeight":12.1,
               "lineLeft":85.05,
               "lineTop":58.033,
               "lineWidth":56.727,
               "text":"Second page",
               "textCoordinates":[  
                  85.05,
                  32.538,
                  120.074,
                  21.703
               ]
            }
         ]
      }
   ]
}

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Get Document Information