Follow

Upcoming update to getApplication, getApplications, and getPersonApplications

On Friday, June 14th, we'll be updating the following API tasks:

  • getApplication
  • getApplications
  • getPersonApplications

Here's a full shakedown of the upcoming changes:

getApplication

We will begin returning more specific answer data for the fields returned by the getApplication task. Currently, the task returns something like:

	<field>
	    <id>23</id>
	    <name>Education Level</name>
	    <description></description>
	    <is_required>0</is_required>
	    <data_type>CHOICE</data_type>
	    <data_format>EDUCATION_LEVEL</data_format>
	    <status>ACCEPTED</status>
	    <submitted_at>2014-02-10 15:46:35</submitted_at>
	    <decision_at>2014-02-10 16:10:45</decision_at>
	    <has_options>1</has_options>
	    <order_id>7</order_id>
	    <answer>3333</answer>
	</field>

After the update, the task will return more specific information—for example:

	<field>
	    <id>23</id>
	    <name>Education Level</name>
	    <description></description>
	    <is_required>0</is_required>
	    <data_type>CHOICE</data_type>
	    <data_format>EDUCATION_LEVEL</data_format>
	    <status>ACCEPTED</status>
	    <submitted_at>2014-02-10 15:46:35</submitted_at>
	    <decision_at>2014-02-10 16:10:45</decision_at>
	    <has_options>1</has_options>
	    <order_id>7</order_id>
	    <answer>
	        <education_level_id>3333</education_level_id>
	        <education_level_name>High School Diploma</education_level_name>
	    </answer>
	</field>

For one example of what we're changing, the current way merely returns the Ed. Level ID in the <answer> element. If you wanted the name of the Ed. Level, you would have to make an additional API call.

getApplications & getPersonApplications

All three calls mentioned in this announcement will now return more consistent, standardized data, which will include specific names (in addition to IDs) wherever possible (e.g. Bachelor of Arts instead of 65423879).

		<application>
		    <id>54321</id>
		    <lead_id>3214</lead_id>
		    <person_id>1234</person_id>
		    <first_name>Carl</first_name>
		    <first_name></preferred_name>
		    <middle_name>Allen</middle_name>
		    <last_name>Michaelson</last_name>
		    <gender>MALE</gender>
		    <email>carl@email.org</email>
		    <application_template_id>112</application_template_id>
		    <application_template_name>Basic</application_template_name>
		    <representative_id>2068</representative_id>
		    <program_id>333</program_id>
		    <program_name>Undergraduate</program_name>
		    <degree_seeking>1</degree_seeking>
		    <degree_id>444</degree_id>
		    <degree_abbreviation>B.A.</degree_abbreviation>
		    <degree_name>Bachelor of Arts</degree_name>
		    <specialization_id>5555</specialization_id>
		    <specialization_abbreviation>ENG</specialization_abbreviation>
		    <specialization_name>English</specialization_name>
		    <academic_term_id>7769</academic_term_id>
		    <academic_term_name>2014-2015: Fall</academic_term_name>
		    <expected_enrollment>FULL_TIME</expected_enrollment>
		    <full_time>1</full_time>
		    <started_on>2014-02-07</started_on>
		    <submitted_at></submitted_at>
		    <decision_on></decision_on>
		    <withdrawn_on></withdrawn_on>
		    <submitted_type>ONLINE</submitted_type>
		    <provisional>0</provisional>
		    <provisional_comment></provisional_comment>
		    <fee_status>PAID</fee_status>
		    <fee_id>8467</fee_id>
		    <fee_amount>25.00</fee_amount>
		    <fee_payment>BEFORE_START</fee_payment>
		    <applicant_activity_at>2014-02-10 15:46:35</applicant_activity_at>
		    <num_days_since_last_activity>3</num_days_since_last_activity>
		    <staff_activity_at>2014-02-10 16:10:45</staff_activity_at>
		    <percent_completed>95</percent_completed>
		    <status>IN_PROGRESS</status>
		</application>

If you have any questions, we'd love to hear from you!

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.