REST API: GET document loopblocks (Publisher)

You can use the REST API to retrieve the loop blocks of an emailing document with an HTTP GET call to the following URL:$id/loopblocks

Where $id should be replaced with the ID of the emailing document.

Returned fields

The method returns a JSON object containing the following information:

  • ID: The ID of the loop block.
  • parentID: The ID of the parent of the loop block
  • name: The name of the loop block.
  • iteration: Iteration that the image block is in.
  • condition: Conditions of the loop block.
  • iterations: Number of iterations of the loop block.

JSON example

  "data": [
        "ID": "1",
        "parentID": "",
        "name": "loopblock1",
        "iteration": "0",
        "condition": "",
        "iterations": "1"
        "ID": "2",
        "parentID": "1",
        "name": "loopblock2",
        "iteration": "1",
        "condition": "",
        "iterations": 0

PHP example

The script below demonstrates how to use this API method. Don't forget to replace the ID in the URL before executing the call.

// dependencies

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);

// execute the call

This example requires the REST API class

More information