Successful request

Failed requests

Generic errors can be expected.

The template engine used to render the templates is Velocity, a summery of the most common syntax is listed below, the full documentation can be found in the Velocity user guide.

Please note all variable access and syntax is case sensitive.

Variables

Variables are referenced with a dollar sign ($) followed by the variable name between curly brackets ({}). The use of the curly brackets is optional in most cases, one exception is when the boundary between the variable and the next word is not clear.

When a variable does not exist or does not have a value the tag is not replaced, by adding a exclamation mark (!) after the dollar sign the variable will be silently ignored.

Full notation: ${brand.organization}
Short notation: $brand.organization
Undefined field: $brand.fax
Undefined field, silent: $!brand.fax

Full notation: Organization
Short notation: Organization
Undefined field: $brand.fax
Undefined field, silent:

If / Else statement

The #if directive allows for text to be included, on the conditional that the if statement is true. For example:

#if( $brand.fax )
Fax number: $brand.fax
#else
No fax number available
#end

No fax number available

Foreach Loop

The #foreach element allows for looping over lists. A loop counter is provided in the variable $foreach.count, the counter starts at 1.

#foreach( $addressLine in $brand.addressLines )
Address line $foreach.count: $addressLine
#end

Address line 1: Address

A number of utility tools are available in the template to perform output formatting.

Date Tool

Tool for working with dates in templates. It is useful for accessing and formatting the "current" date as well as for formatting Date and variables.

Full documentation can be found on: http://velocity.apache.org/tools/1.4/javadoc/org/apache/velocity/tools/generic/DateTool.html

Created on: $date.format("long_date", $domain.createdDate)

Created on: January 1, 2000

Escape Tool

Tool for escaping in templates. It provides methods to escape for various outputs.

Full documentation can be found on: http://velocity.apache.org/tools/1.4/javadoc/org/apache/velocity/tools/generic/EscapeTool.html

Escaped organization: $escape.html($brand.organization)

Escaped organization: Org & co

Media Tool

Tool for accessing media files attached to the template, only available in HTML templates. This tool provides access to the path of the media file dependent on the template output method, Web or Email.

Two methods are provider:

contains(String)

Checks if a media file is present with the template.

get(String)

Returns the path for the media file.

#if( $media.contains("logo") )
    <img alt="$brand.organization" src="$media.get("logo")">
#end

<img alt="Organization" src="/logo.jpg">

The variables available per differ per template, variables available in all templates are.

Templates

Additional variables per template are listed below, templates not listed here do not have additional variables.

ERRP_MONTH

ERRP_WEEK

ERRP_EXPIRED

EXPIRED_PAGE

PENDING_VALIDATION

VALIDATE_CONTACT

VALIDATE_CONTACT_FORM

INCOMING_FOA_FORM, INCOMING_TRANSFER_NEW_REGISTRANT_FORM

INCOMING_TOKEN_FORM

INTERNAL_FOA_FORM, INTERNAL_TRANSFER_NEW_REGISTRANT_FORM

INTERNAL_TOKEN_FORM

OUTGOING_FOA_FORM

WDRP

WHOIS

CONFIRM_BRAND

CONFIRM_BRAND_FORM

INCOMING_FOA, INCOMING_TRANSFER_NEW_REGISTRANT

INTERNAL_FOA

INTERNAL_TRANSFER_NEW_REGISTRANT

OUTGOING_FOA

UPDATE_DOMAIN_TOKEN_FORM

TMCH_CLAIM_ACK, TMCH_CLAIM_ACK_AND_VALIDATION

TMCH_CLAIM_ACK_FORM, TMCH_CLAIM_ACK_AND_VALIDATION_FORM

UPDATE_CONTACT_OLD_REGISTRANT, UPDATE_CONTACT_OLD_REGISTRANT_FORM

UPDATE_CONTACT_NEW_REGISTRANT_FORM, UPDATE_CONTACT_NEW_REGISTRANT

UPDATE_DOMAIN_OLD_REGISTRANT, UPDATE_DOMAIN_NEW_REGISTRANT

UPDATE_DOMAIN_OLD_REGISTRANT_FORM, UPDATE_DOMAIN_NEW_REGISTRANT_FORM

NEW_REGISTRANT_CHANGE_NOTIFICATION, OLD_REGISTRANT_CHANGE_NOTIFICATION

UPDATE_DOMAIN

CLEAR_DOMAIN_REGISTRANT

CLEAR_DOMAIN_REGISTRANT_FORM

CLEAR_DOMAIN_REGISTRANT_CONFIRMATION

Common objects

Some object structures are used multiple times, their structure is listed below.

Country

The Country object itself will output the countries name, other attributes available are:

Brand

The Brand object itself will output the brand's organization, other attributes available are:

Contact

The Contact object itself will output the contact's organization if present, otherwise the contact's name, other attributes available are:

DomainContact

The domainContact object itself will the contact's role and organization if present otherwise the contact's name, other attributes available are:

Domain

The Domain object itself will output the domains idn domain name, other attributes available are: