API endpoint /v1/clients/{clientId}/pdf

Request

Request body (json):

• debug: true => show debugging information in output, such as grid lines
• locale: locale for output (i.e. number format)
  Note: Will affect the formatting of numbers and dates from Excel tables. Numbers and dates in ms-word are considered to be fixed text.
• template:
  template data to use.
  You can embed the template (use “data” field),
  or add a reference (use “src” and “lastModified” fields)
  • data
    base64 encode template xml
  • src
    Url to template xml
  • lastModified (optional)
    Date/Time template xml is last modified
    If lastModified is missing the template xml is always downloaded from src;
    if not, the cache is checked.
• settings:
  template settings values (in this case: type=type1)
• page:
  page name (as in template xml)
• fields
  • name:
    field name (as in template xml)
  • contentType
    mime type of content
  • text
    content for other types,
    type=text string or base64 encoded string
    • text/plain => plain text
    • text/html or application/xhtml+xml => html
  • src
    url of content for images, Word, Excel, etc
  • range range name of table in case of Excel
  • lastModified (optional)
    Date/Time src is last modified
    If lastModified is missing src is always downloaded; if not, the cache is checked.
  • docs (optional) Excel documents with tables used in Word input. See: here

Example request

POST /v1/clients/test/pdf HTTP/1.1
Host: https://api-test.share-enterprise.nl
Content-Type: application/json  
Accept: application/json  
Token: xxxxx
<json>

• Request with template data
• Request with template url
• Request with html text

Response

• result:
  url of result pdf
• pageNb:
  number of pages in result

Example:

{
    "result": "v1/clients/testdata/pdf/5c4f823c-74a2-4cef-bb00-20d29fc6636e.pdf",
    "pageNb": 3
}

Result pdf can be retrieved with a GET from the result url.
Note: please also use Token in GET request header.