Items from the domain "layouts" represent a layout. A layout is assigned to a document and determines the look-and-feel of a printed document.
Structure of URLs:
https://api.simplybooks.be/api/v1/layouts: Layouts
https://api.simplybooks.be/api/v1/layouts/8001: Layout with ID 8001
Domain: Layouts
| Field name | Type | Description | Example |
|---|---|---|---|
| layout_id | int | Unique ID of the layout. Generated by the system. To be specified in URL. | 8001 |
| name | text | Name of the layout. Required field. Up to 50 characters long. | My layout |
| version | text | Type of generator of the layout. Can contain the value "predefined", "dompdf1", or "custom_dompdf". | dompdf1 |
| settings | list | Variables used by the generator to build the layout. Depending on the generator used. | – |
| template | text | HTML template of the layout. Based on the template, a printed document is created | – |
| active | text | Describes whether the layout is active. Can have a value of 'yes' or 'no'. | yes |
Example in XML of a layout:
<layout>
<layout_id>8001</layout_id>
<name>Mijn layout</name>
<version>dompdf1</version>
<settings>
<value1>value</value1>
</settings>
<template><html>Mijn template</html></template>
<active>yes</active>
</layout> More info about the API? Read the useful articles below