Skip to content

Terra Dotta Software API Documentation


Back to Terra Dotta Software API Documentation Return to StudioAbroad

getProgramBrochure

Returns data for a specific program brochure

URL
http://{site root}/piapi/index.cfm?callName=getProgramBrochure
The value for {site root} would represent your installation URL. The values returned from this function are in the following table.


Top
Table 1: Input arguments for getProgramBrochure Standard Input Parameters (jump to call specific input arguments) Argument Type Required Meaning ResponseEncoding String Optional The data format to be returned by the API call. The value for ResponseEncoding can be one of the following values:
    Applicable values:
    (case insensitive)
  • XML - eXtensible Markup Language (default)
  • JSON - JavaScript Object Notation
  • SOAP - Simple Object Access Protocol
CallBack Boolean Optional Used with JSON only to specify if a callback function will be used or not. CallBackName String Optional Used with JSON only to specify the callback function to use. Call-specific Input Parameters (jump to standard input arguments) Argument Type Required Meaning program_id Integer Required Program ID number Options List Optional List of the brochure content areas to retrieve. If no list is used, all content areas are returned.

Available list items:

  • all
  • locations
  • terms
  • parameters
  • budgetsheets
  • testimonials
  • dates
  • reviews
  • ratings
ViewableParams Integer Optional Flag used to return only program-level parameters that have Available for display? set to Yes. 1 is the only value accepted. SearchableParams Integer Optional Flag used to return only program-level parameters that have Available for search? set to Yes. 1 is the only value accepted.


Top
Table 2: Return values for getProgramBrochure
Depending on the program type, some of the nodes may or may not be available. The following is a representation of all available nodes for all program types.
Return Value Type Meaning
autostatusid Integer Numeric identifier indicating the default status set of new applications:
  • 0 or NULL = status is not set automatically (default)
  • 1 = Advising
  • 2 = Pending
  • 3 = Waitlist
  • 4 = Accepted
  • 5 = Committed
  • 6 = Rejected
  • 7 = Withdrawn
directory_modified Date Date in which the Directory subscribed-to program was modified.
group_id Integer Numeric identifier of the program group in which the program resides.
notification_list_apply String List of notification recipients when a new application is created.
notification_list_request String List of notification recipients when a new information request is submitted.
program_active Integer Indicates if the program is active; 1 is yes. 0 is no.
program_app_instructions Object An object containing application instructions for each application phase. The complex object will resemble the following:
<program_app_instructions>
    
<pre_decision></pre_decision>
    
<post_decision></post_decision>
    
<while_abroad></while_abroad>
    
<returnee></returnee>            
</program_app_instructions>
program_blog_enabled String Indicates if the journal is enabled at the program level; 1 is yes. 0 is no.
program_brochure String Program WYSIWYG data.
program_brochure2 String Non-Directory program WYSIWYG data. This only applies to programs subsribed to from StudioAbroad Directory.
program_brochure_file String Internal UUID used to obtain the brochure content.
program_brochure2_file String Internal UUID used to obtain the non-Directory brochure content. This only applies to programs subsribed to from StudioAbroad Directory.
program_created Date Date in which the program was created.
program_equiv_enabled Integer Indicates if credit equivalency is enabled for the program. 1 is yes. 0 or NULL is no.
program_home_page String Program homepage URL.
program_id Integer Unique program identifier (ID).
program_is_directory Integer Is this a StudioAbroad Directory sponsored program or not. 1 is yes. 0 or NULL is no.
program_is_own Integer Is the StudioAbroad Directory program published by your institution. 1 is yes. 0 or NULL is no.
program_modified Date Date in which the program was last modified.
program_name String The name of the program.
program_notes String Program notes.
program_type_id Integer An integer value that represents the type of program it is.
    Possible values:
  • 1 - Outgoing with SideTrips and OneStep
  • 2 - Inbound Exchange
  • 3 - Scholarship
  • 4 - Risk Management
  • 14 - Advising

restrict_user_type_id String Program user restriction type:
  • I = Allow only Internal Users
  • E = Allow only External Users
  • B or NULL = Allow only Both Internal and External Users (default)
sponsor_email String StudioAbroad Directory program sponsor contact email address.
sponsor_id Integer Unique identifier representing the StudioAbroad Directory program sponsor.
sponsor_name String StudioAbroad Directory program sponsor contact name.
bexchangeavailable Integer Indicates whether or not the exchange option is available for this program. 1 is yes. 0 or NULL is no.
isfeatured Integer Indicates whether or not the program is featured. 1 is yes. 0 or NULL is no.
locations Object An object containing locations for the program. The complex object will resemble the following:
<locations>
    
<location>
        
<program_city>Hyderabad</program_city>
        
<program_country>India</program_country>
        
<program_region>Asia</program_region>
        
<program_latitude>17.37528</program_latitude>
        
<program_longitude>78.47444</program_longitude>
    
</location>
    
<location>
        
<program_city>Pune</program_city>
        
<program_country>India</program_country>
        
<program_region>Asia</program_region>
        
<program_latitude>18.51957</program_latitude>
        
<program_longitude>73.85535</program_longitude>
    
</location>
</locations>
program_city
(locations > location)
String The program city.
program_country
(locations > location)
String The program country.
program_region
(locations > location)
String The program region.
program_latitude
(locations > location)
Decimal Latitude coordinate for the the program location.
program_longitude
(locations > location)
Decimal Longitude coordinate for the the program location.
terms Object An object containing term information for the program. The complex object will resemble the following:
<terms>
    
<term>
        
<program_term>Fall</program_term>
    
</term>
    
<term>
        
<program_term>Spring</program_term>
    
</term>
</terms>
program_term
(terms > term)
String The descriptive name of the program term.
parameters Object An object containing parameter information for the program. The complex object will resemble the following:
<parameters>
    
<parameter>
        
<param_id>10008</param_id>
        
<param_type>MINIM</param_type>
        
<program_param_text>Minimum GPA</program_param_text>
        
<param_gloss>The minimum GPA in order to apply to this program.</param_gloss>
        
<param_viewable>1</param_viewable>
        
<param_searchable>1</param_searchable>
        
<param_ordinal>1</param_ordinal>
        
<param_value>3.0</param_value>
    
</parameter>
</parameters>
param_id
(parameters > parameter)
Integer Unique identifier for the program parameter (ID).
param_type
(parameters > parameter)
String This value indicates the parameter type:
    Possible returned values:
  • MULTI - Multiple-selection parameter
  • SELCT - Single-selection parameter
  • YESNO - Yes or No parameter
  • MINIM - Minimum Value parameter
  • MAXIM - Maximum Value parameter
program_param_text
(parameters > parameter)
String Program parameter.
param_gloss
(parameters > parameter)
String Program parameter glossary.
param_viewable
(parameters > parameter)
Integer Numeric value indicating the selection for "Available for display?" within the program parameter create and edit screens. 1 = "Yes"; 0 = "No". A value entered will return parameters based on this critera; however, if no value is chosen, the default is to return all parameters.
param_searchable
(parameters > parameter)
Integer Numeric value indicating the selection for "Available for search?" within the program parameter create and edit screens. 1 = "Yes"; 0 = "No". A value entered will return parameters based on this critera; however, if no value is chosen, the default is to return all parameters.
param_ordinal
(parameters > parameter)
Integer The internal sort order for the program parameter (typically used for placement within progam search pages).
param_value
(parameters > parameter)
String The value chosen for the program parameter.
budgetsheets Object An object containing budget sheet information for the program. The complex object will resemble the following:
<budgetsheets>
    
<budget>
        
<budget_title>Fall</budget_title>
        
<budget_term>
            
<link href="index.cfm?FuseAction=Programs.BudgetSheet&Term=Fall&Program_ID=10024"></link>
        
</budget_term>
    
</budget>
</budgetsheets>
budget_title
(bugetsheets > budget)
String Name of the budget sheet.
budget_term
(bugetsheets > budget)
String Link provided to the budget sheet term (if budget sheets are enabled).
courses_offered String Link provided to the courses offered (for credit equivalency, if enabled).
apply_now String Whether or not applications are being accepted. If "Yes," a link is provided to the "Apply Now" destination page.
info_request String Whether or not programs are accepting information requests. If "Yes," a link is provided to the "Request Info" destination page.
request_advising String Whether or not programs are accepting advising request. If "Yes," a link is provided to the "Request Advising" destination page.
print_options String Series of links for each printing option:
  • HTML portrait
  • HTML landscape
  • PDF portrait
  • PDF landscape
testimonials Object An object containing testimonial information for the program. The complex object will resemble the following:
<testimonials>
    
<testimonial>
        
<app_item_text>Question Name</app_item_text>
        
<datecompleted>2012-05-05 12:00:00</datecompleted>
        
<isanonymous>0</isanonymous>
        
<questionnaire_name>Testimonial Name</questionnaire_name>
        
<response_data>Response...</response_data>
        
<user_first_name>First Name</user_first_name>
        
<user_last_name>Last Name</user_last_name>
        
<user_middle_name>Middle Name</user_middle_name>
        
<program_term>Fall</program_term>
        
<program_year>2012</program_year>
        
<bdualyearterm>0</bdualyearterm>
    
</testimonial>
</testimonials>
app_item_id
(testimonials > testimonial)
Integer Unique identifier for the testimonial question item (ID).
app_item_ordinal
(testimonials > testimonial)
Integer The numeric value indicating the preferred question item order.
app_item_text
(testimonials > testimonial)
String Testimonial question item name
app_item_type
(testimonials > testimonial)
String Testimonial question item type:
  • SELCT = Single selection
  • MULTI = Multiple choice
  • SHORT = Short description
  • FIELD = Text field
  • ESSAY = Essay
  • YESNO = Yes / No
  • IFYXP = If no, explain.
  • IFNXP = If yes, explain.
  • DATEO = Date object.
  • DATLK = Data Lookup.
  • DATAX = Data Lookup w/Search.
datecompleted
(testimonials > testimonial)
Date Date in which the testimonial was completed
isanonymous
(testimonials > testimonial)
Integer Indicates whether or not the testimonial is anonymous or not. 1 is yes, 0 is no.
iscomplete
(testimonials > testimonial)
Integer Indicates whether or not the testimonial is completed or not. 1 is yes, 0 is no.
ispublishable
(testimonials > testimonial)
Integer Indicates whether or not the testimonial is publishable or not. 1 is yes, 0 is no.
ispublished
(testimonials > testimonial)
Integer Indicates whether or not the testimonial is published or not. 1 is yes, 0 is no.
program_term
(testimonials > testimonial)
String Testimonial program term name.
program_year
(testimonials > testimonial)
Integer Testimonial program year.
questionnaire_id
(testimonials > testimonial)
Integer Testimonial unique identifier (ID).
questionnaire_int_ext
(testimonials > testimonial)
String Applicability indicator for the testimonial:
  • I = Applies only to Internal Users
  • E = Applies only to External Users
  • B or NULL = Applies to both Internal and External Users (default)
questionnaire_name
(testimonials > testimonial)
String Testimonial questionnaire name
questionnaire_type
(testimonials > testimonial)
String Testimonial (questionnaire) type (will always return "TML").
response_data
(testimonials > testimonial)
String Testimonial question item response data.
response_id
(testimonials > testimonial)
Integer Unique identifier for the testimonial question item response (ID).
student_id
(testimonials > testimonial)
Integer Unique identifier for the user that submitted the testimonial (ID).
user_first_name
(testimonials > testimonial)
String First name of the user that left the testimonial
user_last_name
(testimonials > testimonial)
String Last name of the user that left the testimonial
user_middle_name
(testimonials > testimonial)
String Middle name, is supplied, of the user that left the testimonial
reviews Object An object containing reviews information for the program. The complex object will resemble the following:
<reviews>
    
<review>
        
<app_item_id>40</app_item_id>
        
<app_item_text>How could this program be improved in the future?</app_item_text>
        
<ispublishable>1</ispublishable>
        
<ispublished>1</ispublished>
        
<program_term>Winter</program_term>
        
<program_year>2010</program_year>
        
<response_data>test</response_data>
        
<user_first_name>Elizabath</user_first_name>
        
<user_middle_name>H</user_middle_name>
        
<user_last_name>Turker</user_last_name>
        
<name_publishable>1</name_publishable>
    
</review>
</reviews> 
app_item_id
(reviews > review)
Integer Unique identifier for the review question item (ID).
app_item_text
(reviews > review)
String Review question item name.
ispublishable
(reviews > review)
Integer Whether or not the review is publishable. 1 = Yes, 0 = No.
ispublished
(reviews > review)
Integer Whether or not the review is already published. 1 = Yes, 0 = No.
program_term
(reviews > review)
String Review program term name
program_year
(reviews > review)
Integer Review program year
response_data
(reviews > review)
String Review question item response data.
user_first_name
(reviews > review)
String First name of the user for published review
user_middle_name
(reviews > review)
String Middle name of the user for published review
user_last_name
(reviews > review)
String Last name of the user for published review
name_publishable
(reviews > review)
String Is applicant name is publishable or not; 1 is yes. 0 is no.
ratings Object An object containing ratings information for the program. The complex object will resemble the following:
<ratings>
    
<rating>
        
<app_item_id>40</app_item_id>
        
<app_item_text>Ratings Question #1</app_item_text>
        
<rating_stars>3</rating_stars>
    
</rating>
</ratings>
app_item_id
(ratings > rating)
Integer Unique identifier for the ratings question item (ID).
app_item_text
(ratings > rating)
String Ratings question item name.
rating_stars
(ratings > rating)
Integer Indicates the number ratings stars chosen for a particular question item.
dates object An object containing dates information for the program. The complex object will resemble the following:
<dates>
    
<date>
        
<app_term>Fall</app_term>
        
<app_deadline>2012-05-15 00:00:00.0</app_deadline>
        
<app_decision>2012-06-16 00:00:00.0</app_decision>
        
<app_term_year>Fall|2012</app_term_year>
        
<app_year>2012</app_year>
        
<bdualyearterm/>
        
<benabledatenotes/>
        
<override>2012-05-15 00:00:00.0</override>
        
<override2>2012-06-16 00:00:00.0</override2>
        
<program_term_date_info/>
        
<term_end/>
        
<term_start/> 
    
</date>
</dates>
app_term
(dates > date)
String Program date term.
app_deadline
(dates > date)
Date Program deadline date.
app_decision
(dates > date)
Date Program decision date.
app_term_year
(dates > date)
String Program term and year combined. Returned in the following format: TERM|YEAR
app_year
(dates > date)
String Program term year.
bdualyearterm
(dates > date)
Integer Indicates whether or not the program term is dual year (i.e., 2010-2011). 1 is yes. 0 or NULL is no.
benabledatenotes
(dates > date)
String Enable program date notes. 1 is yes. 0 or NULL is no.
override
(dates > date)
Date Program term application deadline date override.
override2
(dates > date)
Date Program term application decision date override.
program_term_date_info
(dates > date)
String Program term notes.
term_end
(dates > date)
Date Program term end date.
term_start
(dates > date)
Date Program term start date.


Using our original call: We would receive a packet of data in XML format (the default), that might resemble the following:
(the following XML packet is formatted for readability)
<brochure>
    
<details>
        
<autostatusid/>
        
<directory_modified/>
        
<group_id/>
        
<notification_list_apply/>
        
<notification_list_request/>
        
<program_active>1</program_active>
        
<program_app_instructions>0</program_app_instructions>
        
<program_blog_enabled>1</program_blog_enabled>
        
<program_brochure>
            
<p><em><font color="#000000" face="times new roman,times,serif" size="5"><strong>Japanese Intensive Language Program</strong></font></em></p><p><img align="right" alt="Tokyo" border="0" hspace="10" src="_customtags/ct_Image.cfm?Image_ID=705" vspace="1"/></p><p>The Japanese Intensive Language Study program is a great way for students with advanced language skills to quickly and effectively gain the fluent use of Japanese while also experiencing the complex culture of Tokyo and the surrounding environs. The method used by this program is complete immersion. The student will be given minimal instruction in English throughout the whole term while also receiving a constant course in Japanese. The combination of both intensive instruction and cultural interaction has been shown to have measurable results equivalent to years of classroom instruction in an English-speaking environment. </p><p><strong><em><font face="times new roman,times,serif" size="5">Tokyo, Japan</font></em></strong></p><p>One of the largest cities in the world, Tokyo's megalopolis has an area of 223 square miles (or 577 sq km) and is home to over eight and a half million people.  Tokyo is considered to be the cultural, <img align="left" alt="Shrine" border="0" hspace="10" src="_customtags/ct_Image.cfm?Image_ID=706" vspace="1"/>educational and scientific center of Japan.  The National Theatre, the National Museum, the NHK (Radio Symphony Orchestra) and the Japan Philharmonic Orchestra are some of the finest examples of what Tokyo has to offer culturally.</p><p>Tokyo is Japan's largest and most densely populated city; a bustling, state-of-the-art marketplace full of energy, humanity and astonishing contrasts.</p><p>Millions of people pack the subways, sidewalks, and stores to maximum capacity every day and every hour.  In some parts of the city, the streets are as crowded at 3 am as they are at 3 pm.  With its full-force, sensory overload, Tokyo makes even New York City seem like a sleep town.</p><p>Despite its limited space for harmonious living, Tokyo remains one of the safest cities in the world, with very little crime or violence.  Hardworking, honest, and helpful to strangers, the Japanese people are Japan's greatest asset.</p><p/><p><strong><em><font face="times new roman,times,serif" size="5">Terra Dotta Students in Japan</font></em></strong></p><p><a href="index.cfm?w=05%2F14%2F2006&jid=10019&FuseAction=Public.Journals">photo journal</a>.</p><p/> </program_brochure>
        
<program_brochure_file>C644452D-D493-582F-F3932819635CF0F8</program_brochure_file>
        
<program_created>2004-04-06 12:00:00.0</program_created>
        
<program_equiv_enabled>1</program_equiv_enabled>
        
<program_home_page/>
        
<program_id>10001</program_id>
        
<program_is_directory/>
        
<program_is_own>1</program_is_own>
        
<program_modified>2010-09-12 00:00:00.0</program_modified>
        
<program_name>Japanese Intensive Language Study</program_name>
        
<program_notes>
            Saiki Nagano has been our Study Abroad contact in Tokyo for the past 10 years. He helped us launch this program and has been critical to the success. The Fall and Year 2006 programs will be the last that he will be overseeing. Our new contact is Chiyo Akita. She has been at the University in Tokyo for 6 1/2 years and has worked in their Study Abroad Office. Ms. Akita has worked closely with Mr. Nagano so we anticipate a smooth transaction for our 2007 study abroad students.
        
</program_notes>
        
<program_type_id>1</program_type_id>
        
<restrict_user_type_id>B</restrict_user_type_id>
        
<sponsor_email>steve.sweitzer@gmail.com</sponsor_email>
        
<sponsor_id/>
        
<sponsor_name/>
        
<locations>
            
<location>
                
<program_city>Tokyo</program_city>
                
<program_country>Japan</program_country>
                
<program_region>Asia</program_region>
                
<program_latitude>35.61488</program_latitude>
                
<program_longitude>139.5813</program_longitude>
            
</location>
        
</locations>
        
<terms>
            
<term>
                
<program_term>Academic Year</program_term>
            
</term>
            
<term>
                
<program_term>Fall</program_term>
            
</term> 
            
<term>
                
<program_term>Spring</program_term>
            
</term>
        
</terms> 
        
<parameters>
            
<parameter>
                
<param_id>10001</param_id>
                
<param_type>MULTI</param_type>
                
<program_param_text>Instruction language</program_param_text>
                
<param_gloss>
                This is the language (or languages) in which courses are taught. It is sometimes independent of the native language of the country where the program takes place.
                
</param_gloss>
                
<param_viewable>1</param_viewable>
                
<param_searchable>1</param_searchable>
                
<param_ordinal>1</param_ordinal>
                
<param_value>Japanese</param_value>
            
</parameter> 
            
<parameter>
                
<param_id>10000</param_id>
                
<param_type>MULTI</param_type>
                
<program_param_text>Eligibility</program_param_text>
                
<param_gloss>
                Eligibility refers to the class status that must be attained in order to participate in a program. The greatest percentage of our programs require a student to be at least a sophomore. However, there are several programs which call for the student to be at least a junior. There can be other eligibility requirements for participation. See GPA and Language Requirement.
                
</param_gloss>
                
<param_viewable>1</param_viewable>
                
<param_searchable>1</param_searchable>
                
<param_ordinal>2</param_ordinal>                
                
<param_value>2 Sophomore</param_value>
            
</parameter>
            
<parameter>
                
<param_id>10002</param_id>
                
<param_type>SELCT</param_type>
                
<program_param_text>Target Language</program_param_text>
                
<param_gloss/>
                
<param_viewable>1</param_viewable>
                
<param_searchable>1</param_searchable>
                
<param_ordinal>3</param_ordinal>
                
<param_value>Japanese</param_value>
            
</parameter> 
            
<parameter>
                
<param_id>10006</param_id>
                
<param_type>MINIM</param_type>
                
<program_param_text>Minimum GPA</program_param_text>
                
<param_gloss/>
                
<param_viewable>1</param_viewable>
                
<param_searchable>1</param_searchable>
                
<param_ordinal>4</param_ordinal>                
                
<param_value>3.0</param_value>
            
</parameter> 
            
<parameter>
                
<param_id>10008</param_id>
                
<param_type>MULTI</param_type>
                
<program_param_text>Housing Options</program_param_text>
                
<param_gloss/>
                
<param_viewable>1</param_viewable>
                
<param_searchable>1</param_searchable>
                
<param_ordinal>5</param_ordinal>                
                
<param_value>Apartment</param_value>
            
</parameter> 
            
<parameter>
                
<param_id>10008</param_id>
                
<param_type>MULTI</param_type>
                
<program_param_text>Housing Options</program_param_text>
                
<param_gloss/>
                
<param_viewable>1</param_viewable>
                
<param_searchable>1</param_searchable>
                
<param_ordinal>5</param_ordinal>                
                
<param_value>Dormitory</param_value>
            
</parameter> 
            
<parameter>
                
<param_id>10009</param_id>
                
<param_type>YESNO</param_type>
                
<program_param_text>Satisfies diversity req</program_param_text>
                
<param_gloss/>
                
<param_viewable>1</param_viewable>
                
<param_searchable>1</param_searchable>
                
<param_ordinal>6</param_ordinal>                
                
<param_value>Yes</param_value>
            
</parameter>
        
</parameters> 
        
<budgetsheets>
            
<budget>
                
<budget_title>Fall</budget_title>
                
<budget_term>
                    
<link href="index.cfm?FuseAction=Programs.BudgetSheet&Term=Fall&Program_ID=10001"/>
                </
budget_term>
            
</budget>
            
<budget>
                
<budget_title>Year</budget_title>
                
<budget_term>
                       
<link href="index.cfm?FuseAction=Programs.BudgetSheet&Term=Year&Program_ID=10001"/>
                </
budget_term>
            
</budget> 
        
</budgetsheets>
        
<courses_offered>
            
<link href="index.cfm?FuseAction=Programs.ForeignCourses&Program_ID=10001"/>
        </
courses_offered>
        
<apply_now>
            
<enabled>YES</enabled>
            
<link href="index.cfm?FuseAction=Students.Apply&Program_ID=10001"/>
        </
apply_now>
        
<info_request>
            
<enabled>YES</enabled>
            
<link href="index.cfm?FuseAction=Programs.InfoRequest"/>
        </
info_request>
        
<request_advising>
            
<enabled>0</enabled>
        
</request_advising>
        
<print_options>
            
<link href="index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=html&orientation=portrait" orientation="portrait" output="html"/>
            <
link href="index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=html&orientation=landscape" orientation="landscape" output="html"/>
            <
link href="index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=pdf&orientation=portrait" orientation="portrait" output="pdf"/>
            <
link href="index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=pdf&orientation=landscape" orientation="landscape" output="pdf"/> 
        </
print_options>
        <testimonials>
            
<testimonial>
                
<app_item_text>Question Name</app_item_text>
                
<datecompleted>2012-05-05 12:00:00</datecompleted>
                
<isanonymous>0</isanonymous>
                
<questionnaire_name>Testimonial Name</questionnaire_name>
                
<response_data>Response...</response_data>
                
<user_first_name>First Name</user_first_name>
                
<user_last_name>Last Name</user_last_name>
                
<user_middle_name>Middle Name</user_middle_name>
                
<program_term>Fall</program_term>
                
<program_year>2012</program_year>
                
<bdualyearterm>0</bdualyearterm>
            
</testimonial>
        
</testimonials>
        
<reviews>
            
<review>
                
<app_item_id>40</app_item_id>
                
<app_item_text>How could this program be improved in the future?</app_item_text>
                
<ispublishable>1</ispublishable>
                
<ispublished>1</ispublished>
                
<program_term>Winter</program_term>
                
<program_year>2010</program_year>
                
<response_data>test</response_data>
                
<user_first_name>Elizabath</user_first_name>
                
<user_middle_name>H</user_middle_name>
                
<user_last_name>Turker</user_last_name>
                
<name_publishable>1</name_publishable>
            
</review>
        
</reviews> 
        
<ratings>
            
<rating>
                
<app_item_id>40</app_item_id>
                
<app_item_text>RatingQstn</app_item_text>
                
<rating_stars>3</rating_stars>
            
</rating>
        
</ratings> 
        
<dates>
            
<date>
                
<app_term>Spring</app_term>
                
<app_deadline>2010-11-15 00:00:00.0</app_deadline>
                
<app_decision>2010-10-30 00:00:00.0</app_decision>
                
<app_term_year>Spring|2011</app_term_year>
                
<app_year>2011</app_year>
                
<bdualyearterm/>
                
<benabledatenotes/>
                
<override>2010-11-15 00:00:00.0</override>
                
<override2>2010-10-30 00:00:00.0</override2>
                
<program_term_date_info/>
                
<term_end/>
                
<term_start/>
            
</date>
            
<date>
                
<app_term>Academic Year</app_term>
                
<app_deadline>2011-05-15 00:00:00.0</app_deadline>
                
<app_decision>2011-05-30 00:00:00.0</app_decision>
                
<app_term_year>Academic Year|2011</app_term_year>
                
<app_year>2011</app_year>
                
<bdualyearterm>1</bdualyearterm>
                
<benabledatenotes/>
                
<override>2011-05-15 00:00:00.0</override>
                
<override2>2011-05-30 00:00:00.0</override2>
                
<program_term_date_info/>
                
<term_end/>
                
<term_start/>
            
</date> 
            
<date>
                
<app_term>Fall</app_term>
                
<app_deadline>2011-05-15 00:00:00.0</app_deadline>
                
<app_decision>2011-05-30 00:00:00.0</app_decision>
                
<app_term_year>Fall|2011</app_term_year>
                
<app_year>2011</app_year>
                
<bdualyearterm/>
                
<benabledatenotes/>
                
<override>2011-05-15 00:00:00.0</override>
                
<override2>2011-05-30 00:00:00.0</override2>
                
<program_term_date_info/>
                
<term_end/>
                
<term_start/>
            
</date>
            
<date>
                
<app_term>Fall</app_term>
                
<app_deadline>2012-05-15 00:00:00.0</app_deadline>
                
<app_decision>2012-06-16 00:00:00.0</app_decision>
                
<app_term_year>Fall|2012</app_term_year>
                
<app_year>2012</app_year>
                
<bdualyearterm/>
                
<benabledatenotes/>
                
<override>2012-05-15 00:00:00.0</override>
                
<override2>2012-06-16 00:00:00.0</override2>
                
<program_term_date_info/>
                
<term_end/>
                
<term_start/> 
            
</date>
        
</dates> 
    
</details> 
</brochure>

We can modify the call to return the data in SOAP format by specifying ResponseEncoding=SOAP:
http://{site root}/piapi/index.cfm?callName=getProgramBrochure&Program_ID=10001&ResponseEncoding=SOAP
We would receive a packet of XML wrapped within a SOAP envelope that might resemble the following:
(the following XML packet is formatted for readability)
<soapenv:Envelope 
    xmlns:soapenv
="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:xsd
="http://www.w3.org/2001/XMLSchema" 
    xmlns:xsi
="http://www.w3.org/2001/XMLSchema-instance">
    
<soapenv:Body>
        
<brochure>
            
<details>
                
<autostatusid/>
                
<directory_modified/>
                
<group_id/>
                
<notification_list_apply/>
                
<notification_list_request/>
                
<program_active>1</program_active>
                
<program_app_instructions>0</program_app_instructions>
                
<program_blog_enabled>1</program_blog_enabled>
                
<program_brochure>
                    
<p><em><font color="#000000" face="times new roman,times,serif" size="5"><strong>Japanese Intensive Language Program</strong></font></em></p><p><img align="right"         alt="Tokyo" border="0" hspace="10" src="_customtags/ct_Image.cfm?Image_ID=705" vspace="1"/></p><p>The Japanese Intensive Language Study program is a great way for students with         advanced language skills to quickly and effectively gain the fluent use of Japanese while also experiencing the complex culture of Tokyo and the surrounding environs. The method used         by this program is complete immersion. The student will be given minimal instruction in English throughout the whole term while also receiving a constant course in Japanese. The         combination of both intensive instruction and cultural interaction has been shown to have measurable results equivalent to years of classroom instruction in an English-speaking         environment. </p><p><strong><em><font face="times new roman,times,serif" size="5">Tokyo, Japan</font></em></strong></p><p>One of the largest cities in the world, Tokyo's megalopolis         has an area of 223 square miles (or 577 sq km) and is home to over eight and a half million people.  Tokyo is considered to be the cultural, <img align="left" alt="Shrine" border="0"         hspace="10" src="_customtags/ct_Image.cfm?Image_ID=706" vspace="1"/>educational and scientific center of Japan.  The National Theatre, the National Museum, the NHK (Radio Symphony         Orchestra) and the Japan Philharmonic Orchestra are some of the finest examples of what Tokyo has to offer culturally.</p><p>Tokyo is Japan's largest and most densely populated city;         a bustling, state-of-the-art marketplace full of energy, humanity and astonishing contrasts.</p><p>Millions of people pack the subways, sidewalks, and stores to maximum capacity         every day and every hour.  In some parts of the city, the streets are as crowded at 3 am as they are at 3 pm.  With its full-force, sensory overload, Tokyo makes even New York City         seem like a sleep town.</p><p>Despite its limited space for harmonious living, Tokyo remains one of the safest cities in the world, with very little crime or violence.  Hardworking,         honest, and helpful to strangers, the Japanese people are Japan's greatest asset.</p><p/><p><strong><em><font face="times new roman,times,serif" size="5">Terra Dotta Students in         Japan</font></em></strong></p><p><a href="index.cfm?w=05%2F14%2F2006&jid=10019&FuseAction=Public.Journals">photo journal</a>.</p><p/> </program_brochure>
                
<program_brochure_file>C644452D-D493-582F-F3932819635CF0F8</program_brochure_file>
                
<program_created>2004-04-06 12:00:00.0</program_created>
                
<program_equiv_enabled>1</program_equiv_enabled>
                
<program_home_page/>
                
<program_id>10001</program_id>
                
<program_is_directory/>
                
<program_is_own>1</program_is_own>
                
<program_modified>2010-09-12 00:00:00.0</program_modified>
                
<program_name>Japanese Intensive Language Study</program_name>
                
<program_notes>
                    Saiki Nagano has been our Study Abroad contact in Tokyo for the past 10 years. He helped us launch this program and has been critical to the success. The Fall and Year 2006 programs will be the last that he will be overseeing. Our new contact is Chiyo Akita. She has been at the University in Tokyo for 6 1/2 years and has worked in their Study Abroad Office. Ms. Akita has worked closely with Mr. Nagano so we anticipate a smooth transaction for our 2007 study abroad students.
                
</program_notes>
                
<program_type_id>1</program_type_id>
                
<restrict_user_type_id>B</restrict_user_type_id>
                
<sponsor_email>steve.sweitzer@gmail.com</sponsor_email>
                
<sponsor_id/>
                
<sponsor_name/>
                
<locations>
                    
<location>
                        
<program_city>Tokyo</program_city>
                        
<program_country>Japan</program_country>
                        
<program_region>Asia</program_region>
                        
<program_latitude>35.61488</program_latitude>
                        
<program_longitude>139.5813</program_longitude>
                    
</location>
                
</locations>
                
<terms>
                    
<term>
                        
<program_term>Academic Year</program_term>
                    
</term>
                    
<term>
                        
<program_term>Fall</program_term>
                    
</term> 
                    
<term>
                        
<program_term>Spring</program_term>
                    
</term>
                
</terms> 
                
<parameters>
                    
<parameter>
                        
<param_id>10001</param_id>
                        
<param_type>MULTI</param_type>
                        
<program_param_text>Instruction language</program_param_text>
                        
<param_gloss>
                        This is the language (or languages) in which courses are taught. It is sometimes independent of the native language of the country where the program takes place.
                        
</param_gloss>
                        
<param_viewable>1</param_viewable>
                        
<param_searchable>1</param_searchable>
                        
<param_ordinal>1</param_ordinal>
                        
<param_value>Japanese</param_value>
                    
</parameter> 
                    
<parameter>
                        
<param_id>10000</param_id>
                        
<param_type>MULTI</param_type>
                        
<program_param_text>Eligibility</program_param_text>
                        
<param_gloss>
                        Eligibility refers to the class status that must be attained in order to participate in a program. The greatest percentage of our programs require a student to be at least a sophomore. However, there are several programs which call for the student to be at least a junior. There can be other eligibility requirements for participation. See GPA and Language Requirement.
                        
</param_gloss>
                        
<param_viewable>1</param_viewable>
                        
<param_searchable>1</param_searchable>
                        
<param_ordinal>2</param_ordinal>                
                        
<param_value>2 Sophomore</param_value>
                    
</parameter>
                    
<parameter>
                        
<param_id>10002</param_id>
                        
<param_type>SELCT</param_type>
                        
<program_param_text>Target Language</program_param_text>
                        
<param_gloss/>
                        
<param_viewable>1</param_viewable>
                        
<param_searchable>1</param_searchable>
                        
<param_ordinal>3</param_ordinal>
                        
<param_value>Japanese</param_value>
                    
</parameter> 
                    
<parameter>
                        
<param_id>10006</param_id>
                        
<param_type>MINIM</param_type>
                        
<program_param_text>Minimum GPA</program_param_text>
                        
<param_gloss/>
                        
<param_viewable>1</param_viewable>
                        
<param_searchable>1</param_searchable>
                        
<param_ordinal>4</param_ordinal>                
                        
<param_value>3.0</param_value>
                    
</parameter> 
                    
<parameter>
                        
<param_id>10008</param_id>
                        
<param_type>MULTI</param_type>
                        
<program_param_text>Housing Options</program_param_text>
                        
<param_gloss/>
                        
<param_viewable>1</param_viewable>
                        
<param_searchable>1</param_searchable>
                        
<param_ordinal>5</param_ordinal>                
                        
<param_value>Apartment</param_value>
                    
</parameter> 
                    
<parameter>
                        
<param_id>10008</param_id>
                        
<param_type>MULTI</param_type>
                        
<program_param_text>Housing Options</program_param_text>
                        
<param_gloss/>
                        
<param_viewable>1</param_viewable>
                        
<param_searchable>1</param_searchable>
                        
<param_ordinal>5</param_ordinal>                
                        
<param_value>Dormitory</param_value>
                    
</parameter> 
                    
<parameter>
                        
<param_id>10009</param_id>
                        
<param_type>YESNO</param_type>
                        
<program_param_text>Satisfies diversity req</program_param_text>
                        
<param_gloss/>
                        
<param_viewable>1</param_viewable>
                        
<param_searchable>1</param_searchable>
                        
<param_ordinal>6</param_ordinal>                
                        
<param_value>Yes</param_value>
                    
</parameter>
                
</parameters> 
                
<budgetsheets>
                    
<budget>
                        
<budget_title>Fall</budget_title>
                        
<budget_term>
                            
<link href="index.cfm?FuseAction=Programs.BudgetSheet&Term=Fall&Program_ID=10001"/>
                        </
budget_term>
                    
</budget>
                    
<budget>
                        
<budget_title>Year</budget_title>
                        
<budget_term>
                               
<link href="index.cfm?FuseAction=Programs.BudgetSheet&Term=Year&Program_ID=10001"/>
                        </
budget_term>
                    
</budget> 
                
</budgetsheets>
                
<courses_offered>
                    
<link href="index.cfm?FuseAction=Programs.ForeignCourses&Program_ID=10001"/>
                </
courses_offered>
                
<apply_now>
                    
<enabled>YES</enabled>
                    
<link href="index.cfm?FuseAction=Students.Apply&Program_ID=10001"/>
                </
apply_now>
                
<info_request>
                    
<enabled>YES</enabled>
                    
<link href="index.cfm?FuseAction=Programs.InfoRequest"/>
                </
info_request>
                
<request_advising>
                    
<enabled>0</enabled>
                
</request_advising>
                
<print_options>
                    
<link href="index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=html&orientation=portrait" orientation="portrait" output="html"/>
                    <
link href="index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=html&orientation=landscape" orientation="landscape" output="html"/>
                    <
link href="index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=pdf&orientation=portrait" orientation="portrait" output="pdf"/>
                    <
link href="index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=pdf&orientation=landscape" orientation="landscape" output="pdf"/> 
                </
print_options>
                <testimonials>
                    
<testimonial>
                        
<app_item_text>Question Name</app_item_text>
                        
<datecompleted>2012-05-05 12:00:00</datecompleted>
                        
<isanonymous>0</isanonymous>
                        
<questionnaire_name>Testimonial Name</questionnaire_name>
                        
<response_data>Response...</response_data>
                        
<user_first_name>First Name</user_first_name>
                        
<user_last_name>Last Name</user_last_name>
                        
<user_middle_name>Middle Name</user_middle_name>
                        
<program_term>Fall</program_term>
                        
<program_year>2012</program_year>
                        
<bdualyearterm>0</bdualyearterm>
                    
</testimonial>
                
</testimonials>
                
<reviews>
                    
<review>
                        
<app_item_id>40</app_item_id>
                        
<app_item_text>How could this program be improved in the future?</app_item_text>
                        
<ispublishable>1</ispublishable>
                        
<ispublished>1</ispublished>
                        
<program_term>Winter</program_term>
                        
<program_year>2010</program_year>
                        
<response_data>test</response_data>
                        
<user_first_name>Elizabath</user_first_name>
                        
<user_middle_name>H</user_middle_name>
                        
<user_last_name>Turker</user_last_name>
                        
<name_publishable>1</name_publishable>
                    
</review>
                
</reviews> 
                
<ratings>
                    
<rating>
                        
<app_item_id>40</app_item_id>
                        
<app_item_text>RatingQstn</app_item_text>
                        
<rating_stars>3</rating_stars>
                    
</rating>
                
</ratings> 
                
<dates>
                    
<date>
                        
<app_term>Spring</app_term>
                        
<app_deadline>2010-11-15 00:00:00.0</app_deadline>
                        
<app_decision>2010-10-30 00:00:00.0</app_decision>
                        
<app_term_year>Spring|2011</app_term_year>
                        
<app_year>2011</app_year>
                        
<bdualyearterm/>
                        
<benabledatenotes/>
                        
<override>2010-11-15 00:00:00.0</override>
                        
<override2>2010-10-30 00:00:00.0</override2>
                        
<program_term_date_info/>
                        
<term_end/>
                        
<term_start/>
                    
</date>
                    
<date>
                        
<app_term>Academic Year</app_term>
                        
<app_deadline>2011-05-15 00:00:00.0</app_deadline>
                        
<app_decision>2011-05-30 00:00:00.0</app_decision>
                        
<app_term_year>Academic Year|2011</app_term_year>
                        
<app_year>2011</app_year>
                        
<bdualyearterm>1</bdualyearterm>
                        
<benabledatenotes/>
                        
<override>2011-05-15 00:00:00.0</override>
                        
<override2>2011-05-30 00:00:00.0</override2>
                        
<program_term_date_info/>
                        
<term_end/>
                        
<term_start/>
                    
</date> 
                    
<date>
                        
<app_term>Fall</app_term>
                        
<app_deadline>2011-05-15 00:00:00.0</app_deadline>
                        
<app_decision>2011-05-30 00:00:00.0</app_decision>
                        
<app_term_year>Fall|2011</app_term_year>
                        
<app_year>2011</app_year>
                        
<bdualyearterm/>
                        
<benabledatenotes/>
                        
<override>2011-05-15 00:00:00.0</override>
                        
<override2>2011-05-30 00:00:00.0</override2>
                        
<program_term_date_info/>
                        
<term_end/>
                        
<term_start/>
                    
</date>
                    
<date>
                        
<app_term>Fall</app_term>
                        
<app_deadline>2012-05-15 00:00:00.0</app_deadline>
                        
<app_decision>2012-06-16 00:00:00.0</app_decision>
                        
<app_term_year>Fall|2012</app_term_year>
                        
<app_year>2012</app_year>
                        
<bdualyearterm/>
                        
<benabledatenotes/>
                        
<override>2012-05-15 00:00:00.0</override>
                        
<override2>2012-06-16 00:00:00.0</override2>
                        
<program_term_date_info/>
                        
<term_end/>
                        
<term_start/> 
                    
</date>
                
</dates> 
            
</details> 
        
</brochure>
    
</soapenv:Body>
</soapenv:Envelope>


We can modify the call to return the data in JSON format by specifying ResponseEncoding=JSON:
http://{site root}/piapi/index.cfm?callName=getProgramBrochure&Program_ID=10001&ResponseEncoding=JSON
We would receive a JSON-encoded packet:
(the following JSON packet is formatted for readability)
_cb_getProgramBrochure({
   "DETAILS":{
      "PROGRAM_EQUIV_ENABLED":1,
      "TERMS":{
         "TERM":{
            "3":{
               "PROGRAM_TERM":"Spring"
            },
            "2":{
               "PROGRAM_TERM":"Fall"
            },
            "1":{
               "PROGRAM_TERM":"Academic Year"
            }
         }
      },
      "PARAMETERS":{
         "PARAMETER":{
            "3":{
               "PARAM_TYPE":"SELCT",
               "PARAM_GLOSS":"",
               "PARAM_ORDINAL":3,
               "PARAM_VALUE":"Japanese",
               "PARAM_ID":10002,
               "PARAM_SEARCHABLE":1,
               "PROGRAM_PARAM_TEXT":"Target Language",
               "PARAM_VIEWABLE":1
            },
            "2":{
               "PARAM_TYPE":"MULTI",
               "PARAM_GLOSS":"Eligibility refers to the class status that must be attained in order to participate in a program. The greatest percentage of our programs require a student to be at least a sophomore. However, there are several programs which call for the student to be at least a junior. There can be other eligibility requirements for participation. See GPA and Language Requirement.",
               "PARAM_ORDINAL":2,
               "PARAM_VALUE":"2 Sophomore",
               "PARAM_ID":10000,
               "PARAM_SEARCHABLE":1,
               "PROGRAM_PARAM_TEXT":"Eligibility",
               "PARAM_VIEWABLE":1
            },
            "1":{
               "PARAM_TYPE":"MULTI",
               "PARAM_GLOSS":"This is the language (or languages) in which courses are taught. It is sometimes independent of the native language of the country where the program takes place.",
               "PARAM_ORDINAL":1,
               "PARAM_VALUE":"Japanese",
               "PARAM_ID":10001,
               "PARAM_SEARCHABLE":1,
               "PROGRAM_PARAM_TEXT":"Instruction language",
               "PARAM_VIEWABLE":1
            },
            "7":{
               "PARAM_TYPE":"YESNO",
               "PARAM_GLOSS":"",
               "PARAM_ORDINAL":6,
               "PARAM_VALUE":"Yes",
               "PARAM_ID":10009,
               "PARAM_SEARCHABLE":1,
               "PROGRAM_PARAM_TEXT":"Satisfies diversity req",
               "PARAM_VIEWABLE":1
            },
            "6":{
               "PARAM_TYPE":"MULTI",
               "PARAM_GLOSS":"",
               "PARAM_ORDINAL":5,
               "PARAM_VALUE":"Dormitory",
               "PARAM_ID":10008,
               "PARAM_SEARCHABLE":1,
               "PROGRAM_PARAM_TEXT":"Housing Options",
               "PARAM_VIEWABLE":1
            },
            "5":{
               "PARAM_TYPE":"MULTI",
               "PARAM_GLOSS":"",
               "PARAM_ORDINAL":5,
               "PARAM_VALUE":"Apartment",
               "PARAM_ID":10008,
               "PARAM_SEARCHABLE":1,
               "PROGRAM_PARAM_TEXT":"Housing Options",
               "PARAM_VIEWABLE":1
            },
            "4":{
               "PARAM_TYPE":"MINIM",
               "PARAM_GLOSS":"",
               "PARAM_ORDINAL":4,
               "PARAM_VALUE":3.0,
               "PARAM_ID":10006,
               "PARAM_SEARCHABLE":1,
               "PROGRAM_PARAM_TEXT":"Minimum GPA",
               "PARAM_VIEWABLE":1
            }
         }
      },
      "APPLY_NOW":{
         "ENABLED":"YES",
         "LINK":{
            "HREF":"index.cfm?FuseAction=Students.Apply&Program_ID=10001"
         }
      },
      "PROGRAM_HOME_PAGE":"",
      "PROGRAM_TYPE_ID":"1",
      "NOTIFICATION_LIST_APPLY":"",
      "PROGRAM_IS_DIRECTORY":"",
      "LOCATIONS":{
         "LOCATION":{
            "PROGRAM_LONGITUDE":139.5813,
            "PROGRAM_REGION":"Asia",
            "PROGRAM_LATITUDE":35.61488,
            "PROGRAM_CITY":"Tokyo",
            "PROGRAM_COUNTRY":"Japan"
         }
      },
      "NOTIFICATION_LIST_REQUEST":"",
      "RATINGS":{
         "RATING":{
            "APP_ITEM_TEXT":"RatingQstn",
            "APP_ITEM_ID":40,
            "RATING_STARS":3
         }
      },
      "COURSES_OFFERED":{
         "LINK":{
            "HREF":"index.cfm?FuseAction=Programs.ForeignCourses&Program_ID=10001"
         }
      },
      "DATES":{
         "DATE":{
            "3":{
               "TERM_END":"",
               "APP_YEAR":2011,
               "APP_TERM_YEAR":"Fall|2011",
               "APP_DECISION":"2011-05-30 00:00:00.0",
               "TERM_START":"",
               "OVERRIDE":"2011-05-15 00:00:00.0",
               "BDUALYEARTERM":"",
               "APP_DEADLINE":"2011-05-15 00:00:00.0",
               "OVERRIDE2":"2011-05-30 00:00:00.0",
               "BENABLEDATENOTES":"",
               "PROGRAM_TERM_DATE_INFO":"",
               "APP_TERM":"Fall"
            },
            "2":{
               "TERM_END":"",
               "APP_YEAR":2011,
               "APP_TERM_YEAR":"Academic Year|2011",
               "APP_DECISION":"2011-05-30 00:00:00.0",
               "TERM_START":"",
               "OVERRIDE":"2011-05-15 00:00:00.0",
               "BDUALYEARTERM":1,
               "APP_DEADLINE":"2011-05-15 00:00:00.0",
               "OVERRIDE2":"2011-05-30 00:00:00.0",
               "BENABLEDATENOTES":"",
               "PROGRAM_TERM_DATE_INFO":"",
               "APP_TERM":"Academic Year"
            },
            "1":{
               "TERM_END":"",
               "APP_YEAR":2011,
               "APP_TERM_YEAR":"Spring|2011",
               "APP_DECISION":"2010-10-30 00:00:00.0",
               "TERM_START":"",
               "OVERRIDE":"2010-11-15 00:00:00.0",
               "BDUALYEARTERM":"",
               "APP_DEADLINE":"2010-11-15 00:00:00.0",
               "OVERRIDE2":"2010-10-30 00:00:00.0",
               "BENABLEDATENOTES":"",
               "PROGRAM_TERM_DATE_INFO":"",
               "APP_TERM":"Spring"
            },
            "4":{
               "TERM_END":"",
               "APP_YEAR":2012,
               "APP_TERM_YEAR":"Fall|2012",
               "APP_DECISION":"2012-06-16 00:00:00.0",
               "TERM_START":"",
               "OVERRIDE":"2012-05-15 00:00:00.0",
               "BDUALYEARTERM":"",
               "APP_DEADLINE":"2012-05-15 00:00:00.0",
               "OVERRIDE2":"2012-06-16 00:00:00.0",
               "BENABLEDATENOTES":"",
               "PROGRAM_TERM_DATE_INFO":"",
               "APP_TERM":"Fall"
            }
         }
      },
      "PROGRAM_MODIFIED":"2010-09-12 00:00:00.0",
      "PROGRAM_ACTIVE":1,
      "PROGRAM_NOTES":"Saiki Nagano has been our Study Abroad contact in Tokyo for the past 10 years. He helped us launch this program and has been critical to the success. The Fall and Year 2006 programs will be the last that he will be overseeing. Our new contact is Chiyo Akita. She has been at the University in Tokyo for 6 1\/2 years and has worked in their Study Abroad Office. Ms. Akita has worked closely with Mr. Nagano so we anticipate a smooth transaction for our 2007 study abroad students.",
      "BUDGETSHEETS":{
         "BUDGET":{
            "2":{
               "BUDGET_TERM":{
                  "LINK":{
                     "HREF":"index.cfm?FuseAction=Programs.BudgetSheet&Term=Year&Program_ID=10001"
                  }
               },
               "BUDGET_TITLE":"Year"
            },
            "1":{
               "BUDGET_TERM":{
                  "LINK":{
                     "HREF":"index.cfm?FuseAction=Programs.BudgetSheet&Term=Fall&Program_ID=10001"
                  }
               },
               "BUDGET_TITLE":"Fall"
            }
         }
      },
      "GROUP_ID":"",
      "PROGRAM_BROCHURE":{
         "P":{
            "3":"The Japanese Intensive Language Study program is a great way for students with advanced language skills to quickly and effectively gain the fluent use of Japanese while also experiencing the complex culture of Tokyo and the surrounding environs. The method used by this program is complete immersion. The student will be given minimal instruction in English throughout the whole term while also receiving a constant course in Japanese. The combination of both intensive instruction and cultural interaction has been shown to have measurable results equivalent to years of classroom instruction in an English-speaking environment.",
            "2":{
               "IMG":{
                  "ALT":"Tokyo",
                  "ALIGN":"right",
                  "VSPACE":1,
                  "HSPACE":10,
                  "SRC":"_customtags\/ct_Image.cfm?Image_ID=705",
                  "BORDER":0
               }
            },
            "10":{
               "STRONG":{
                  "EM":{
                     "FONT":{
                        "SIZE":5,
                        "FACE":"times new roman,times,serif"
                     }
                  }
               }
            },
            "1":{
               "EM":{
                  "FONT":{
                     "COLOR":"#000000",
                     "SIZE":5,
                     "FACE":"times new roman,times,serif",
                     "STRONG":"Japanese Intensive Language Program"
                  }
               }
            },
            "7":"Millions of people pack the subways, sidewalks, and stores to maximum capacity every day and every hour.  In some parts of the city, the streets are as crowded at 3 am as they are at 3 pm.  With its full-force, sensory overload, Tokyo makes even New York City seem like a sleep town.",
            "6":"Tokyo is Japan's largest and most densely populated city; a bustling, state-of-the-art marketplace full of energy, humanity and astonishing contrasts.",
            "5":{
               "P_XMLTEXT":"One of the largest cities in the world, Tokyo's megalopolis has an area of 223 square miles (or 577 sq km) and is home to over eight and a half million people.  Tokyo is considered to be the cultural, educational and scientific center of Japan.  The National Theatre, the National Museum, the NHK (Radio Symphony Orchestra) and the Japan Philharmonic Orchestra are some of the finest examples of what Tokyo has to offer culturally.",
               "IMG":{
                  "ALT":"Shrine",
                  "ALIGN":"left",
                  "VSPACE":1,
                  "HSPACE":10,
                  "SRC":"_customtags\/ct_Image.cfm?Image_ID=706",
                  "BORDER":0
               }
            },
            "4":{
               "STRONG":{
                  "EM":{
                     "FONT":{
                        "SIZE":5,
                        "FACE":"times new roman,times,serif"
                     }
                  }
               }
            },
            "9":"",
            "8":"Despite its limited space for harmonious living, Tokyo remains one of the safest cities in the world, with very little crime or violence.  Hardworking, honest, and helpful to strangers, the Japanese people are Japan's greatest asset.",
            "11":{
               "A":{
                  "HREF":"index.cfm?w=05%2F14%2F2006&jid=10019&FuseAction=Public.Journals"
               },
               "P_XMLTEXT":"."
            },
            "12":""
         }
      },
      "TESTIMONIALS":{
         "TESTIMONIAL":{
            "USER_FIRST_NAME":"Elizabeth",
            "APP_ITEM_TEXT":"What elements of the program did you find most rewarding?",
            "RESPONSE_DATA":"The entire experience was rewarding. I was exposed to a completely different culture.",
            "DATECOMPLETED":"2006-05-05 00:00:00.0",
            "USER_LAST_NAME":"Tucker",
            "PROGRAM_TERM":"Year",
            "QUESTIONNAIRE_NAME":"Evaluation Questionnaire",
            "PROGRAM_YEAR":2005,
            "BDUALYEARTERM":1,
            "USER_MIDDLE_NAME":"P.",
            "ISANONYMOUS":1,
         }
      },
      "PROGRAM_ID":10001,
      "RESTRICT_USER_TYPE_ID":"B",
      "PROGRAM_BLOG_ENABLED":1,
      "REQUEST_ADVISING":{
         "ENABLED":0
      },
      "PROGRAM_CREATED":"2004-04-06 12:00:00.0",
      "INFO_REQUEST":{
         "ENABLED":"YES",
         "LINK":{
            "HREF":"index.cfm?FuseAction=Programs.InfoRequest"
         }
      },
      "PROGRAM_APP_INSTRUCTIONS":0,
      "PROGRAM_IS_OWN":1,
      "SPONSOR_NAME":"",
      "DIRECTORY_MODIFIED":"",
      "AUTOSTATUSID":"",
      "SPONSOR_ID":"",
      "REVIEWS":{
         "REVIEW":{
            "USER_FIRST_NAME":"Elizabath",
            "ISPUBLISHABLE":1,
            "APP_ITEM_TEXT":"How could this program be improved in the future?",
            "RESPONSE_DATA":"test",
            "APP_ITEM_ID":40,
            "NAME_PUBLISHABLE":1,
            "PROGRAM_YEAR":2010,
            "USER_MIDDLE_NAME":"H",
            "USER_LAST_NAME":"Turker",
            "PROGRAM_TERM":"Winter",
            "ISPUBLISHED":1
         }
      },
      "PROGRAM_BROCHURE_FILE":"C644452D-D493-582F-F3932819635CF0F8",
      "SPONSOR_EMAIL":"steve.sweitzer@gmail.com",
      "PRINT_OPTIONS":{
         "LINK":{
            "3":{
               "ORIENTATION":"portrait",
               "OUTPUT":"pdf",
               "HREF":"index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=pdf&orientation=portrait"
            },
            "2":{
               "ORIENTATION":"landscape",
               "OUTPUT":"html",
               "HREF":"index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=html&orientation=landscape"
            },
            "1":{
               "ORIENTATION":"portrait",
               "OUTPUT":"html",
               "HREF":"index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=html&orientation=portrait"
            },
            "4":{
               "ORIENTATION":"landscape",
               "OUTPUT":"pdf",
               "HREF":"index.cfm?FuseAction=Programs.ViewProgram&Program_ID=10001&DocType=pdf&orientation=landscape"
            }
         }
      },
      "PROGRAM_NAME":"Japanese Intensive Language Study"
   }
});
The data returned using JSON encoding is wrapped within the callback function, _cb_getProgramBrochure(). By default, all JSON calls are returned within a callback wrapper function in form of:
_cb_callName()
Where callName represents the name of the function you originally called. To override this, you can specify the callBackName argument, as in:
http://{site root}/piapi/index.cfm?callName=getProgramBrochure&Program_ID=10001&ResponseEncoding=JSON&callBackName=MyCallBackFunction
This call would return the JSON packet wrapped within the callback function, MyCallBackFunction, as in:
_cb_MyCallBackFunction(...json-encoded data...)
In your custom pages, you would then create a corresponding function to handle this custom callback function:
<script language="JavaScript" type="text/javascript">
<!--
// <![CDATA[
function _cb_MyCallBackFunction(data)
{
    
// put additional routines here
}
// ]]>
//-->
</script>
If you would like to receive the data without a callback function, you can use the argument callBack to override this. Specifying a value of false for the callBack argument returns the data without the callback function, as in:
http://{site root}/piapi/index.cfm?callName=getProgramBrochure&ResponseEncoding=JSON&Program_ID=10001&callBack=false
Note: specifying callBack=true is implied and is unnecessary for returning JSON data with a callback function.

Example 1: Following is an example using JSON and client-side JavaScript to render the program names as link and indicating whether or not the programs are incoming:
Run Example 1 Top
(be sure to change the ?program_id=xxxxx value in the URL of this example to return real data. If your installation does not have any data, this example may not return anything)

The code for this example is not shown due to size. To see the code, please open the code file piapi/docs/getProgramBrochure_example1.cfm
Example 2: Following is an example of using ColdFusion to call the API and returning the data in a SOAP envelope:
Run Example 2 Top
(if your installation does not have any data, this example will not return anything)

<!---// local variables //--->
<cfparam name="responsePacket" default="[ no response ]" />
<
cfparam name="url.program_id" default="10001" />

<!---// connect to the API (GET or POST) //--->
<cfhttp result="httpCall" method="post" url="#REQUEST.CurrentAccount.AccountURL()#piapi/index.cfm">
    
<cfhttpparam name="callName" type="url" value="getProgramBrochure" />
    <
cfhttpparam name="ResponseEncoding" type="url" value="SOAP" />
    <
cfhttpparam name="Program_id" type="url" value="#url.program_id#" />
</
cfhttp>

<!---// ensure the response is in XML format //--->
<cfif isXml(httpCall.fileContent)>
    
<!---// parse response //--->
    
<cfset responsePacket = xmlParse(httpCall.fileContent) />
    
<!---// check to see if an error was thrown //--->
    
<cfset err = xmlSearch(responsePacket, "//extrainfo") />
    
<!---// an error was thrown //--->
    
<cfif isArray(err) and not arrayIsEmpty(err)>
        
<!---// throw error //--->
        
<cfthrow message="#err[1].xmlText#" />
        <
cfabort />    
    </
cfif>
<cfelse>
    
<!---// additional error checking //--->
</cfif>

<!---// additional code goes here //--->
<h2>Output for 'responsePacket':</h2>
<cfdump VAR="#responsePacket#" />
For additional techniques, be sure to visit the other program calls within these documentation pages.

Back to Terra Dotta Software API Documentation Top