Retrieve Document Layout

The layout of the document describes the textual content of a document with positional information, based on the processed document.

The layout of the document can be retrieved by a GET request to the layout URI:

Header	Value
`Accept`	`application/vnd.gini.v1+json`

Status Code	Description
200 (OK)	Operation is successful.

Header	Value
`Content-Type`	`application/vnd.gini.v1+json`

Key	Type	Description
`pages`	`array`	Array of page objects.

Key	Type	Description
`number`	`number`	Number of the page starting with 1.
`sizeX`	`number`	Width of the page.
`sizeY`	`number`	Height of the page.
`textZones`	`array`	Array of textzone objects.
`regions`	`array`	Array of region objects.

Key	Type	Description
`paragraphs`	`array`	Array of paragraph objects

Key	Type	Description
`w`	`number`	Width of the paragraph.
`h`	`number`	Height of the paragraph.
`t`	`number`	Distance of the paragraph from the upper edge of the page.
`l`	`number`	Distance of the paragraph from the left edge of the page.
`lines`	`array`	Array of line objects.

Key	Type	Description
`w`	`number`	Width of the line.
`h`	`number`	Height of the line.
`t`	`number`	Distance of the line from the upper edge of the page.
`l`	`number`	Distance of the line from the left edge of the page.
`wds`	`array`	Array of word objects.

Key	Type	Description
`h`	`number`	Height of the word.
`w`	`number`	Width of the word.
`l`	`number`	Distance of the word from the left edge of the page.
`t`	`number`	Distance of the word from the upper edge of the page.
`fontSize`	`number`	Font size of the word in points.
`fontFamily` `string`	Name of the font family of the word.
`bold`	`boolean`	Indicates bold font style.
`text`	`string`	Text of word.

Key	Type	Description
`h`	`number`	Height of the region of interest.
`w`	`number`	Width of the region of interest.
`l`	`number`	Distance of the region from the left edge of the page.
`t`	`number`	Distance of the region from the upper edge of the page.
`type`	`string`	Type of the region of interest, e.g. RemittanceSlip.

Status Code	Description

404 (Not Found) The requested layout is invalid.