Terra Dotta Software API Documentation

Return to Public Site

The Terra Dotta Software API provides functions for accessing public data within the Terra Dotta application.

Supported Features

All API calls support the following features:

IP Restriction: Allow everyone or trusted sites to call your application using the Public Interface API. This is done by editing the stub setting, REQUEST.CurrentAccount.setPublicAPIACL("IP_ADDRESS_LIST"). For full access, empty the setting, as in: REQUEST.CurrentAccount.setPublicAPIACL(""). For trusted sites, set it as REQUEST.CurrentAccount.setPublicAPIACL("IP_ADDRESS_LIST") to the list of IPs you want to have access your site. To restrict access for everyone, set to "NULL": REQUEST.CurrentAccount.setPublicAPIACL("NULL")

Response Encoding: XML, SOAP, JSON. XML is the default if one is not specified.

Protocols: HTTP GET & POST

Returned Column Names: Depending on the language you choose to display this information, the returned column names may be case-sensitive (i.e., when used with JSON). All column names are returned in lowercase.

Methods

The API supports the following methods to send and receive data. Click on a function to view the available interfaces and code examples. Some of the code sample will have the line wrap () icon in them. This indicates that one or more lines was broken up for readability, and should be taken into account.

Program Search:

getPrograms: Call to find programs by program type or activity flag.

getFeaturedPrograms: Call to find featured programs by program type or activity flag.

getProgramSearchElements: Call to return program descriptors used for creating custom program search forms & pages.

getProgramSearchResults: Call to retrieve list of programs & spotlights the featured programs in the list.

getRandomFeaturedPrograms: Call to retrieve a random featured program.

Program Brochure

getProgramBrochure: Call to return all or portions of information used to build a program brochure.

getProgramLocations: Call to obtain all available locations for a specific program.

getProgramParameters: Call to obtain all available parameters or parameters available to a specific program.

getProgramTerms: Call to obtain all terms available to a specific program.

getProgramDeadlines: Call to obtain all deadlines for a specific program.

getProgramTestimonials: Call to retrieve published testimonials for a specific program.

getProgramRandomTestimonial: Call to retrieve a random published testimonial response from a particular program.

Staff Listing:

getStaff: Call to retrieve all active or all inactive staff members. It may also be used to retrieve an individual staff member's details.