GET /v1/templates/info

Request:

curl -u username:password \
  -X GET "https://api.reporting.cloud/v1/templates/info?templateName=sample_invoice.tx"

Results:

{
	"templateName": "sample_invoice.tx",
	"mergeBlocks": [
		{
			"name": "item",
			"mergeFields": [
				{
					"dateTimeFormat": "",
					"name": "qty",
					"numericFormat": "",
					"preserveFormatting": false,
					"text": "«qty»",
					"textAfter": "",
					"textBefore": ""
				}
			],
			"mergeBlocks": []
		}
	],
	"mergeFields": [
		{
			"dateTimeFormat": "",
			"name": "yourcompany_companyname",
			"numericFormat": "",
			"preserveFormatting": false,
			"text": "«YOURCOMPANY_COMPANYNAME»",
			"textAfter": "",
			"textBefore": ""
		},
		{
			"dateTimeFormat": "",
			"name": "invoice_no",
			"numericFormat": "",
			"preserveFormatting": false,
			"text": "«invoice_no»",
			"textAfter": "",
			"textBefore": "#"
		}
	],
	"userDocumentProperties": {}
}

The result is shortened to 1 of the 6 merge fields of the item block and 2 of the 33 merge fields at the root level.

Request:

using System;
using System.Collections.Generic;
using System.Drawing;
using TXTextControl.ReportingCloud;

class RCSamples
{
    public static void GetTemplateInfo(string templateName)
    {
        ReportingCloud rc = new ReportingCloud(
            "username",
            "password",
            new Uri("https://api.reporting.cloud"));

        try
        {
            TemplateInfo templateInfo = rc.GetTemplateInfo(templateName);
            Console.WriteLine(templateInfo.TemplateName);
        }
        catch (Exception e)
        {
            Console.WriteLine("An error occurred: " + e.Message);
        }
    }
}

Results:

sample_invoice.tx

Request:

import com.textcontrol.reportingcloud.MergeBlock;
import com.textcontrol.reportingcloud.MergeField;
import com.textcontrol.reportingcloud.ReportingCloud;
import com.textcontrol.reportingcloud.TemplateInfo;

import java.io.IOException;

public class ReportingCloudSample {
    public static void main(String[] args) throws IOException {
        ReportingCloud r = new ReportingCloud("username", "password");
        TemplateInfo templateInfo = r.getTemplateInfo("sample_invoice.tx");

        System.out.println("Template: " + templateInfo.getTemplateName());
        for (MergeField mergeField : templateInfo.getMergeFields()) {
            System.out.println("Merge field: " + mergeField.getName());
        }
        for (MergeBlock mergeBlock : templateInfo.getMergeBlocks()) {
            System.out.println("Merge block: " + mergeBlock.getName());
        }
    }
}

Results:

Template: sample_invoice.tx
Merge field: yourcompany_companyname
Merge field: invoice_no
Merge block: item

Request:

#!/usr/bin/env ruby

require "txtextcontrol/reportingcloud"

reporting_cloud = TXTextControl::ReportingCloud::ReportingCloud.new("username", "password")
template_info = reporting_cloud.get_template_info("sample_invoice.tx")

puts "Template: #{template_info.template_name}"
template_info.merge_fields.each { |merge_field| puts "Merge field: #{merge_field.name}" }
template_info.merge_blocks.each { |merge_block| puts "Merge block: #{merge_block.name}" }

Results:

Template: sample_invoice.tx
Merge field: yourcompany_companyname
Merge field: invoice_no
Merge block: item

Request:

<?php

require_once __DIR__ . '/vendor/autoload.php';

use TextControl\ReportingCloud\ReportingCloud;

$reportingCloud = new ReportingCloud([
    'api_key' => (string) getenv('REPORTINGCLOUD_API_KEY'),
]);

var_dump($reportingCloud->getTemplateInfo('sample_invoice.tx'));

Results:

array(4) {
  ["template_name"]=>
  string(17) "sample_invoice.tx"
  ["merge_blocks"]=>
  array(1) {
    [0]=>
    array(3) {
      ["name"]=>
      string(4) "item"
      ["merge_fields"]=>
      array(1) {
        [0]=>
        array(7) {
          ["date_time_format"]=>
          string(0) ""
          ["name"]=>
          string(3) "qty"
          ["numeric_format"]=>
          string(0) ""
          ["preserve_formatting"]=>
          bool(false)
          ["text"]=>
          string(7) "«qty»"
          ["text_after"]=>
          string(0) ""
          ["text_before"]=>
          string(0) ""
        }
      }
      ["merge_blocks"]=>
      array(0) {
      }
    }
  }
  ["merge_fields"]=>
  array(2) {
    [0]=>
    array(7) {
      ["date_time_format"]=>
      string(0) ""
      ["name"]=>
      string(23) "yourcompany_companyname"
      ["numeric_format"]=>
      string(0) ""
      ["preserve_formatting"]=>
      bool(false)
      ["text"]=>
      string(27) "«YOURCOMPANY_COMPANYNAME»"
      ["text_after"]=>
      string(0) ""
      ["text_before"]=>
      string(0) ""
    }
    [1]=>
    array(7) {
      ["date_time_format"]=>
      string(0) ""
      ["name"]=>
      string(10) "invoice_no"
      ["numeric_format"]=>
      string(0) ""
      ["preserve_formatting"]=>
      bool(false)
      ["text"]=>
      string(14) "«invoice_no»"
      ["text_after"]=>
      string(0) ""
      ["text_before"]=>
      string(1) "#"
    }
  }
  ["user_document_properties"]=>
  array(0) {
  }
}