Support for

TCAPI: template size

John Valentine
by John Valentine 10 years ago
 

Request template size by id

Syntax
/template_sizes/<templatesize_id>/

Retrieves a template size. Note that we do not publish these IDs in the API, so this is of limited use. Instead, just retrieve all template sizes.

Request list of template sizes

Syntax
/template_sizes/

Retrieves all available template sizes.

Parameter Description
user_key Your application’s key, from developer.templatecloud.com 
format json or xml
templatesize_id One template size id (optional; deprecated)
units imperial or metric (optional).
HTTP request
GET http://api.templatecloud.com/sandbox/template_sizes/?user_key=ba386e729c5f6870cea89f38e92d7a5c&format=json
HTTP response (JSON)
{
    "template_sizes" : [
        {
            "code" : "A4",
            "name" : "A4",
            "width" : "210.0000",
            "height" : "297.0000",
            "bleed" : "1.5000",
            "units" : "mm"
        }, {
            "code" : "A5",
            "name" : "A5",
            "width" : "148.0000",
            "height" : "210.0000",
            "bleed" : "1.5000",
            "units" : "mm"
        },
         ...
    ]
}

Relations

References to template sizes

  • Use template.size.code to find templates having that template size, when include contains size.

    Syntax
    /templates/?...include=size
  • Hidden: The unpublished template_size.id can be used as a template size argument in the API call, to retrieve a single template size:

    Syntax
    /template_sizes/<templatesize_id>/
 

See also

Getting your App Approved

Jump to contents page of

TemplateCloud API Guide

 
 
 

All content is (c) Nettl Systems Limited, 2024 and may not be used, copied or distributed without permission.