Click or drag to resize
GET /form_templates/<job_type_id>
Print this page

This service is used to retrieve available Form Templates for a specific job type, or, if no job type is specified, all templates defined for the customer account.

Example of a valid request:

GET /form_templates/eb8fab4eae8b4634932f5c0e71e11463

No request body is used for this service.

Optional parameters

updated_since ISO 8601 timestamp Finds items by modification time. This retrieves only those objects with one or more timestamp members, one of which falls after the specified timestamp.
list_all false (default), true (only usable with updated_since) If set to true, list_all retrieves a comprehensive list: ProductName returns a larger set of results that includes the IDs (or primary key values) of every object that falls within the selection range and the JSON for the updated objects. Setting list_all to true can be used, for example, if you need to refresh a local cache.
history string (default: "None") This option controls if previous revisions of the definition XML will be returned in the "previousRevisions" property of the form template object. Available options:
  • None: no history will be returned. The "previousRevisions" property of the form object will be null.
  • FullContent: the "previousRevisions" property of the form template object will contain a list of the XML's previous revisions.

On success, the response is a JSON array of form template objects:

Member Type Purpose
id string Uniquely identifies the template. This is an alphanumeric identifier.
name string The human-readable name of the template.
definition string A string containing an XML document that defines the Form Template.
formType string Type of the form template, which is "standard" by default.
revisionNumber int Revision number that increments with each editing of the event (1 indicates the original version).
previousRevisions string[] List of previous definition XMLs in chronological order (the content of this property is controlled by the "history" request parameter).

If the request fails, an Error Response is generated.