API Templates Get By ID

    Purpose

    Retrieve a single template based on the template ID.

    Arguments

    Type Name Description
    int template_id ID of the required template

    Sample Usage

    $client = new SoapClient('http://l001.pageprodigy.com/api/soap/?wsdl');
    
    $session = $client->login('apiUser', 'apiKey');
    $api_result = $client->call($session, 'design_templates.getByID', array($template_id));
    
    echo $api_result ['title'];
    echo $api_result['theme_info']['title'];
    
    

    Returns

    Type Name Description
    array template_array A single templateEntity

    The templateEntity content is as follows:

    Type Name Description
    integer id The ID of the Template
    string title The title of the Template
    string filename The filename of the Template
    string size The size of the template in a human readable format, i.e. A3 11.69" x 16.54", landscape
    string size_in_pixels The size of the template based on 300dpi pixels shown in [width]x[height] whether or not the template is portrait or landscape, i.e. 3508x4961.
    string orientation One of two options: portrait or landscape.
    string description Description of the Template.
    integer borderless Whether or not the Template is borderless. 0 = Has margins, 1 = borderless (bleed).
    integer designer_id The ID of the user who last updated the Template.
    array theme_info Array of a single designTemplateThemeEntity associated with the Template.
    array product_info Array of a single designTemplateProductEntity associated with the Template.
    string created_time Time stamp of the creation date of the design.
    string update_time Time stamp of the most recent update of this design.

    The designTemplateThemeEntity content is as follows:

    Type Name Description
    integer id The ID of the Theme.
    string title Title of the Theme.
    string created_time Time stamp of the creation date of the Theme.
    string update_time Time stamp of the most recent update of this Theme.

    The designTemplateProductEntity content is as follows:

    Type Name Description
    integer id The ID of the Product.
    string title Title of the Product.
    string description Description of the Product.
    string created_time Time stamp of the creation date of the Product.
    string update_time Time stamp of the most recent update of this Product.