Follow

API Reference

addAddress

Adds an address to a person or organization.

Parameters

Parameter Description Required
person_id Numeric ID of the person to whose profile you are attaching this address. No (but either person_id OR organization_id MUST be set)
organization_id Numeric ID of the organization to whose profile you are attaching this address. No (but either person_id OR organization_id MUST be set)
street e.g. 777 Magnolia Ln Yes
city e.g. Moscow Yes
state e.g. ID No
postal e.g. 83843 No
country e.g. USA No
type OTHER (default), HOME, WORK, MAIN, BILLING, SHIPPING No
primary Boolean. Use if you want to mark the address as primary or not primary. e.g. 1 or 0 No
public Boolean. Use if you want to mark the address as public or not public. e.g. 1 or 0 No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<id>88888</id>
</response>

Comments

The current user must have the Staff role or else be adding this address to his/her own profile.

addAdvisorToStudent

Adds an advisor to a student.

Parameters

Parameter Description Required
advisor_id The numeric ID of the advisor you're interested in. Yes
student_id The numeric ID of the student you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

addAidApplication

Adds a new financial aid application to a particular student in a particular aid year.

Parameters

Parameter Description Required
student_id The numeric ID of the student. Yes
aid_year_id The numeric ID of the aid year. Yes
assigned_to_id The numeric ID of the person to whom this aid application is assigned. No
enrollment The student's enrollment status (for financial aid purposes): FULL_TIME, THREE_QUARTER_TIME, HALF_TIME, or LESS_THAN_HALF_TIME (defaults to FULL_TIME) No
dependency Whether this student is considered a dependent for aid purposes: can be blank, DEPENDENT, or INDEPENDENT No
student_aid_class_id The numeric aid class ID for this student (aid classes are how Populi groups similar types of students together). No
program_months The number of months this student is expected to be enrolled in your school's program. No
year_coa This student's Cost of Attendance if they were attending for the entire year (this should be extrapolated out from their program_coa for shorter programs, since Pell calculates based on COA for the entire year). No
program_coa This student's Cost of Attendance in this aid year. No
year_efc This student's Estimated Family Contribution in this aid year (extrapolated out to a full year for shorter programs, if necessary). No
program_efc This student's Estimated Family Contribution in this aid year. No
student_agi This student's Adjusted Gross Income in this aid year. No
parent_agi The parents' Adjusted Gross Income in this aid year. No
legal_residence_state The student's state of legal residence. No
verification Whether this student has been selected for verification. Must be either blank, SELECTED_BY_COLLEGE, or SELECTED_BY_GOVERNMENT. No
verification_status If this student was selected for verification (see above), what's their status? If set, must be one of: IN_PROGRESS, COMPLETED, REJECTED, or EXEMPTED. Cannot be set if `verification` is blank. No
verification_group If this student was selected for verification (see above), what verification group are they in? If set, must be one of: 'Standard, 'Child Support Paid', 'Custom', 'Aggregate', or 'Household Resources'. Cannot be set unless `verification` is set to SELECTED_BY_GOVERNMENT. No
auto_zero_efc Whether the student's EFC was calculated using the "automatic zero" EFC formula. If set, must be: 1 or 0 No
status The application status: SETUP, IN_PROGRESS, COMPLETED, NEEDS_ATTENTION, or CANCELED (defaults to SETUP) No
housing The student's housing situation: ON_CAMPUS, WITH_PARENT, or OFF_CAMPUS No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<result>
<id>123456</id>
</result>

Comments

You must have the Financial Aid role to call this task.

addApplication

Adds an admissions application.

Parameters

Parameter Description Required
application_template_id Numeric ID of the application template. Yes
person_id Numeric ID of the person who is the applicant. No (But either person_id OR first_name, last_name and email_address MUST be set)
lead_id Numeric ID of the lead record this application should be attached to. Defaults to the person's active lead record. If no active lead record exists a new one will be created. Requires person_id. No
first_name The first name of the applicant. No (But either person_id OR first_name, last_name and email_address MUST be set)
middle_name The middle name of the applicant. No
last_name The last name of the applicant. No (But either person_id OR first_name, last_name and email_address MUST be set)
email_address The email address of the applicant. No (But either person_id OR first_name, last_name and email_address MUST be set)
start_date The date this application was started (e.g. 2014-01-15). Defaults to the current date. No
representative_id Numeric ID of the admissions representative who will be assigned to this application. No
program_id Numeric ID of the program the applicant is applying to. No
academic_term_id Numeric ID of the academic term the applicant wishes to enroll in. No
expected_enrollment FULL_TIME (default), HALF_TIME, LESS_THAN_HALF_TIME No
email_link_to_applicant Boolean. A link to the application will be emailed to the applicant. Defaults to true. No
request_email_verification Boolean. An verification email will be sent to the applicant. Defaults to false. No
street The applicant's street address. No
city The applicant's city. No
state The applicant's state or province abbreviation. No
postal The applicant's postal code. No
country The person's country abbreviation. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<id>6974</id>
</response>

Comments

Applications that require a fee can not be created through the API.

If an in progress application already exists for the email_address and application_template_id a new application will not be created and the existing ID will be returned.

addCommunicationPlanToPerson

Adds a communication plans to a person.

Parameters

Parameter Description Required
communication_plan_id The numeric ID of the communication plan you're interested in. Yes
person_id The numeric ID of the person you're interested in. Yes
sender_id The numeric ID of the person who the email/letter will be sent from or who a to-do is assigned by. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <id>99</id>
</response>

Comments

The current user must have the Staff role to call this task.

addCourseInstanceAssignment

Creates an assignment in a particular course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes
name The name of the assignment. Yes
type GRADE_ONLY, FILE_UPLOAD, PEER_REVIEW_FILE_UPLOAD, TEST, ATTENDANCE, DISCUSSION, ESSAY, or PEER_REVIEW_ESSAY Yes
discussion_id Only used when the assignment type is DISCUSSION. The numeric ID of the discussion you want to use (the default is 0 which means a new discussion will be created). No
description A description of the assignment. No
catalog_course_ids Only used if the course is cross-listed. This would be an array of catalog course IDs that the assignment applies to. If you leave this parameter out of the request the assignment will apply to all cross-listed courses. No
points The number of points that the assignment is worth (the default is 0). No
extra_credit Boolean. e.g. 1 or 0 (the default is 0). No
group_id The assignment group ID this assignment belongs to (the default is 0 which is the built-in "Other" group). No
time_due When the assignment is due (e.g. 2017-06-30 23:59:59 - must be in the course instance's timezone). No
visible_to_students_before_due When the passed in type is TEST this sets whether or not the test is visible before it's available (the default is 1). No
     
  The following parameters are only used when the assignment type is TEST:  
availability FROM, AFTER, BEFORE, or ALWAYS (the default is FROM). If the value is FROM and both start_window and end_window are empty then the test will not be available. No
start_window When the test availability starts. Only used when the availability parameter is FROM or AFTER. No
end_window When the test availability ends. Only used when the availability parameter is FROM or BEFORE. No
time_limit The time limit in minutes (the default is 0 which is "No time limit"). No
retake_policy NO_RETAKES (no retakes - the default), KEEP_HIGHEST (keep highest score), KEEP_LAST (keep most recent score), AVERAGE (average all scores). No
retakes The number of retakes allowed (only used when the retake_policy is not NO_RETAKES - the default is 0). No
answers_visible NOT_VISIBLE (not visible - the default), AFTER_TAKING (visible after test completion), AFTER_WINDOW (visible after test end date). No
proctored Boolean. e.g. 1 or 0 (the default is 0). No
     
  The following parameters are only used when the assignment type is PEER_REVIEW_FILE_UPLOAD or PEER_REVIEW_ESSAY:  
peer_grade Boolean. e.g. 1 or 0 (the default is 0). No
grade_submission_points The number of points that submissions are worth (the default is 0). No
grade_review_points The number of points that reviews are worth (the default is 0). No
anonymous_reviews Boolean. e.g. 1 or 0 (the default is 0). No
review_visibility NEVER (not visible to other students - the default), AFTER_REVIEW (visible to other students after their review), ALWAYS (visible to other students). No
allow_review_comments Boolean. e.g. 1 or 0. Only used when review_visibility is not NEVER (the default is 0). No
reviews_time_due When reviews are due (e.g. 2017-06-30 23:59:59 - must be in the course instance's timezone). No
reviews_closed_date_time When reviews are closed (e.g. 2017-06-30 23:59:59 - must be in the course instance's timezone). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<assignment_id>456789</assignment_id>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task.

addCourseInstanceAssignmentGroup

Creates an assignment group in a particular course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes
name The name of the new assignment group. Yes
weight The assignment group's weight percent (the default is 0). No
extra_credit Boolean. e.g. 1 or 0 (the default is 0). No
drop_lowest The number of lowest-graded assignments to drop from this group for each student (the default is 0). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<group_id>1234567</group_id>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task.

addCourseOfferingLink

Adds a link to a particular course offering.

Parameters

Parameter Description Required
course_offering_id The numeric ID of the course offering you're interested in. Yes
name The name of the link. Yes
url The URL for the link. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <link_id>2345</link_id>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task (and the course must not be finalized).

addEmailAddress

Adds an email to a person or organization.

Parameters

Parameter Description Required
person_id Numeric ID of the person to whose profile you are attaching this email address. No (but either person_id OR organization_id MUST be set)
organization_id Numeric ID of the organization to whose profile you are attaching this email address. No (but either person_id OR organization_id MUST be set)
email_address e.g. bob@example.com Yes
type OTHER (default), HOME, WORK No
primary Boolean. Use if you want to mark the email address as primary or not primary. e.g. 1 or 0 No
public Boolean. Use if you want to mark the email address as public or not public. e.g. 1 or 0 No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<id>333333</id>
</response>

Comments

The current user must have the Staff role or else be adding this email address to his/her own profile.

addEnrollment

Adds a student to a particular course offering.

Parameters

Parameter Description Required
course_offering_id The numeric ID of the course offering you're interested in. Yes
student_id The numeric ID of the student you're interested in. Yes
status ENROLLED, AUDITOR, or WAITING (if you have access to the waiting list). The default is ENROLLED. No
status_date What date Populi should recognize the student as added. This is used for financial, add/drop dates, etc. The default is the current date. No
catalog_course_id This is used for cross-listed courses. The default is the primary catalog course ID. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher that can override enrollment to call this task.

addFinancialAidAward

Adds a new financial aid award to a student in a given aid year, and optionally add disbursements.

Parameters

Parameter Description Required
person_id The numeric ID of a student. Yes
aid_year_id The numeric ID of an aid year (see getFinancialAidYears). Yes
award_type_id The numeric ID of an award type (see getFinancialAidAwardTypes). Yes
amount The total/gross amount of this award. Yes
net_amount The net amount of this award. Yes
status Possible values: SETUP, OFFERED, ACCEPTED, DECLINED, CANCELED. Yes
max_amount The maximum amount for this award. No
disbursements A json encoded array of disbursements, each row with the following keys: date, net_amount, gross_amount, academic_term_id No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<result>
<id>123456</id>
</result>

Comments

You must have the Financial Aid role to call this task.

addFinancialAidDisbursement

Adds a new disbursement to an existing financial aid award and returns the ID of the new disbursement.

Parameters

Parameter Description Required
person_id The numeric ID of a student. Yes
award_id The numeric ID of an award. Yes
academic_term_id The numeric ID of an academic term. Yes
scheduled_date The anticipated disbursement date in the format '2012-10-10'. Yes
amount The net amount of this disbursement. Yes
gross_amount The gross net amount of this disbursement. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<result>
<disbursement>123456</disbursement>
</result>

Comments

You must have the Financial Aid role to call this task.

addFinancialAidRefund

Adds a new refund (to source or to student) on an existing financial aid award.

Parameters

Parameter Description Required
person_id The numeric ID of a student. Yes
award_id The numeric ID of an award. Yes
scheduled_date The anticipated refund date in the format '2012-10-10'. Yes
amount The net amount of this disbursement. Yes
type REFUND_TO_STUDENT: The refund is being paid out to the student. This amount will remain on his or her 1098T. REFUND_TO_SOURCE: The refund is being returned to the aid source and will no longer affect the student's 1098T. Yes
asset_account_id The ID of the asset account the money's coming from. Only applies to REFUND_TO_STUDENT type refunds. Yes (for REFUND_TO_STUDENT)

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<result>
<refund>123456</refund>
</result>

Comments

You must have the Financial Aid role to call this task.

addInquiry

Adds a new admissions inquiry.

Parameters

Parameter Description Required
first_name The person's first name. Yes
middle_name The person's middle name. No
last_name The person's last name. Yes
phone The person's phone number. No
email The person's email address. Yes
lead_source_id The numeric ID of the lead source to record for this inquiry. No
program_id The numeric ID of the program the person is interested in. No
degree_id The numeric ID of the degree the person is interested in. No
specialization_id The numeric ID of the degree specialization the person is interested in. No
academic_term_id The numeric ID of the academic term the person is interested in attending. No
content The text content of the person's request No
added_on The date the inquiry was made in the format '2016-10-27' No
counselor_id The numeric ID of the person to assign this inquiry to as a representative. No
create_response Create a response thread and/or email a thank you message on create? Boolean. Defaults to false. No
street The person's street address. No
city The person's city. No
state The person's state or province abbreviation. No
postal The person's postal code. No
country The person's country abbreviation. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <id>43551</id>
</response>

Comments

You must have the Admissions or Admissions Admin role to call this task.

addPayment

Adds a payment to a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
amount The amount of the payment. Yes
asset_account_id The numeric ID of the asset account. Yes
posted_date The transaction's posted date. Defaults to the current date. No
automatically_apply_to_invoices Boolean. Pass in 1 if you want the payment to automatically apply to invoices. Defaults to 0. No
pay_invoices Array. The array key(s) should be the invoice ID(s) that you want the payment to apply to. The array value(s) should be the amount that you want to apply. e.g. array(invoice_id => amount_to_apply_to_invoice, ...). No
paid_by_type PERSON (default) or ORG. No
paid_by_id The numeric ID of the person or org who is making the payment. Defaults to the passed in person_id (the first parameter). No
source_type CASH, CHECK (default), CREDIT_CARD, ACH, MONEY_ORDER, or OTHER. No
reference_number The payment's internal reference number. No
currency USD, CAD, EUR, GBP, MXN, or KYD. Defaults to your organization's main currency. No
exchange_rate Only used when the currency is not your organization's home currency. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <payment_id>1178</payment_id>
    <receipt_number>596fe256b9c4c</receipt_number>
</response>

Comments

You must have the Student Billing or Financial Admin role to call this task.

addPendingCharge

Adds a pending charge to a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
amount The amount of the pending charge. Yes
item_type TUITION, FEE, ROOM_PLAN, or MEAL_PLAN. Yes
item_id Depending on what item_type is passed in this would be a tution bracket ID, a fee ID, a room plan ID, or a meal plan ID. Yes
academic_term_id A pending charge with item_type FEE does not have to be attached to a particular academic term. All other item_types must be attached to a particular academic term. No
description A description for the pending charge. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <pending_charge_id>1111</pending_charge_id>
</response>

Comments

You must have the Student Billing or Financial Admin role to call this task.

addPerson

Adds a new person into Populi. To avoid duplicate records, we strongly recommend calling getPossibleDuplicatePeople before calling addPerson.

Parameters

Parameter Description Required
first_name The official/legal first name for this person (you can set preferred name later). Yes
last_name The last name for the person. Yes
gender MALE, FEMALE, or UNKNOWN (default). No
birth_date e.g. 1979-10-02 No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<id>333333</id>
</response>

Comments

The current user must have the Staff role to call addPerson.

See addPhoneNumber, addEmailAddress, addAddress if you'd like to add contact information to your new person.

addPhoneNumber

Adds a phone number to a person or organization.

Parameters

Parameter Description Required
person_id Numeric ID of the person to whose profile you are attaching this phone number. No (but either person_id OR organization_id MUST be set)
organization_id Numeric ID of the organization to whose profile you are attaching this phone number. No (but either person_id OR organization_id MUST be set)
phone_number e.g. 1-800-888-8888 Yes
type OTHER (default), HOME, WORK, MOBILE, FAX No
primary Boolean. Use if you want to mark the phone number as primary or not primary. e.g. 1 or 0 No
public Boolean. Use if you want to mark the phone number as public or not public. e.g. 1 or 0 No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<id>777777</id>
</response>

Comments

The current user must have the Staff role or else be adding this phone number to his/her own profile.

addProfilePicture

Adds a profile picture to Populi. The ideal dimensions are 600 wide x 750 tall.

Parameters

Parameter Description Required
person_id The numeric ID of the person. Yes
image A base 64 encoded string of the image. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role to call addProfilePicture.

addRole

Adds a role to a person.

Parameters

Parameter Description Required
person_id Numeric ID of the person you're interested in. Yes
role_id The numeric ID of the role you want to add. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>SUCCESS</response>

Comments

The current user must have the Staff role and permission to add the role (this varies by role... so Academic Admins can add the Registrar role, Admissions Admins can add the Admission role, etc).

See getAvailableRoles to look up all possible roles and their numeric IDs.

addStudentDegree

Add a degree to a particular student.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
degree_id The numeric ID of the degree you're interested in. Yes
active_date The active date in the format '2012-10-10'. Yes
catalog_year_id The numeric ID of the catalog year you're interested in. Yes
anticipated_completion_date The anticipated completion date in the format '2012-10-10'. No
show_on_transcript Possible values: 1 (default) or 0. Whether the degree should show on the transcript. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<id>123456</id>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

addStudentDegreeSpecialization

Adds a specialization to student's existing degree.

Parameters

Parameter Description Required
person_id Numeric ID of the person you're interested in. Yes
degree_student_id Numeric ID of the degree_student object in question. Yes
specialization_id Numeric ID of the specialization you wish to add. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Academic Admin or Registrar role to call this task.

addStudentProgram

Add a program to a particular student.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
program_id The numeric ID of the program you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

addTag

Adds a tag to a particular person.

Parameters

Parameter Description Required
person_id Numeric ID of the person who should be tagged. Yes
tag_id Numeric ID of the tag. No (but either tag_id or tag must be set)
tag The actual tag you want to be attached (e.g. "Do not call", or "Good reference"). No (but either tag_id or tag must be set)

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>SUCCESS</response>

Comments

You must have the Staff role to call this task.

If you pass "tag" and that tag doesn't exist, it will be created. If you pass in a tag_id that doesn't exists, a BAD_PARAMETER error will be thrown.

The same tag cannot be attached multiple times to the same person - if the person already has this tag, addTag will return SUCCESS and do nothing.

System tags cannot be assigned by anyone other than Populi... so certain tags like "Expelled" are off-limits. To add these tags, you'll need to take some action in Populi - the correct system tags will be added as a byproduct of that action.

addTodo

Adds a new todo (the Added By of this new todo will show the currently logged-in user).

Parameters

Parameter Description Required
content What the todo should say (e.g. "Remember the milk on the way home from work") Yes
due The due date for this todo (e.g. 2011-06-24) No
assigned_to The person responsible for completing this todo. Defaults to the currently logged-in user. No
attached_to_type If you'd like to attach this todo onto someone's profile, set this to PERSON. No
attached_to If you'd like to attach this todo onto someone's profile, put that person's numeric ID here (and you MUST have attached_to_type set to PERSON). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<result>
<id>123456</id>
</result>

Comments

Right now you can only attach todos to people, so the only legitimate value for attached_to_type is PERSON. If you attach a todo onto someone's profile (say a lead or student who needs to be called), it will be visible to everyone with the Staff role.

If you attach a todo to a person, there will be a handy link to jump to their profile when the todo is displayed on your dasboard.

addUser

Grants user access to a person.

Parameters

Parameter Description Required
person_id Numeric ID of the person whose user account will be created. Yes
username A username for the person. Allowed characters are letters, numbers, period and underscore. If no username is passed in Populi will autogenerate one. No
send_welcome_email Boolean. Send a welcome email to the person's primary email address. If this is not passed in the default is true. No

Comments

You must have the Staff role to call this task.

createCourseInstanceMeeting

Creates a meeting for a particular course instance.

Parameters

Parameter Description Required
instanceID The numeric ID of the course instance you're interested in. Yes
startMonth e.g. 01 Yes
startDay e.g. 01 Yes
startYear e.g. 2016 Yes
startHour Hours should be 0 based. e.g. 0-23 Yes
startMinute Minutes should be 0 based. e.g. 0-59 Yes
endMonth e.g. 01 Yes
endDay e.g. 01 Yes
endYear e.g. 2016 Yes
endHour Hours should be 0 based. e.g. 0-23 Yes
endMinute Minutes should be 0 based. e.g. 0-59 Yes
roomID The numeric ID of the room where the meeting will take place. No
counts_toward_attendance_hours Boolean. e.g. 1 or 0 No
counts_toward_clinical_hours Boolean. e.g. 1 or 0 No
initial_student_attendance_status PRESENT (default), ABSENT, TARDY, EXCUSED, or NONE No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<meetingid>123456789</meetingid>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task.

If you pass in initial_student_attendance_status = NONE then students in the course will not get an attendance record for the new meeting by default. Otherwise, students in the course will get an attendance record (the default status is PRESENT).

createFinancialAidDisbursementBatch

Creates a new financial aid disbursement batch and returns the ID of the new batch.

Parameters

Parameter Description Required
batch_type Must be DISBURSEMENT, REFUND_TO_STUDENT, or REFUND_TO_SOURCE Yes
disbursement_ids An array of disbursement IDs - see addFinancialAidDisbursement Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>123456</id>
</result>

Comments

You must have the Financial Aid role to call this task.

deleteAddress

Deletes an address.

Parameters

Parameter Description Required
addressid Numeric ID of the address. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role or else be deleting an address on his/her own profile.

deleteCommunicationPlanFromPerson

Deletes a communication plans from a person.

Parameters

Parameter Description Required
communication_plan_instance_id The numeric ID of the communication plan instance you're interested in. Yes
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role to call this task.

deleteCourseInstanceAssignment

Deletes an assignment in a particular course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes
assignment_id The numeric ID of the assignment you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task.

deleteCourseInstanceAssignmentGroup

Deletes an assignment group in a particular course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes
group_id The numeric ID of the assignment group you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task.

deleteCourseOfferingLink

Deletes a link attached to a particular course offering.

Parameters

Parameter Description Required
course_offering_id The numeric ID of the course offering you're interested in. Yes
link_id The numeric ID of the link you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task (and the course must not be finalized).

deleteCustomField

Deletes a custom field attached a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
custom_field_id The numeric ID of the custom field you're interested in. Yes
term_id The numeric ID of the term you're interested in. No (but must be set for TERM_STUDENT type fields)

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Staff role to call this task.

deleteEmailAddress

Deletes an email address.

Parameters

Parameter Description Required
emailid Numeric ID of the email address. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role or else be deleting an email address on his/her own profile.

deleteFinancialAidAward

Deletes an existing financial aid award (must not have any posted disbursements).

Parameters

Parameter Description Required
award_id The numeric ID of an award with no posted disbursements. Yes

Comments

You must have the Financial Aid role to call this task.

deleteFinancialAidDisbursement

Deletes an existing disbursement which has not yet been posted.

Parameters

Parameter Description Required
disbursement_id The numeric ID of a disbursement with a status of SETUP or SCHEDULED (but not POSTED, DELETED or VOID) Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Financial Aid role to call this task.

deleteFinancialAidRefund

Deletes an existing refund (REFUND_TO_STUDENT, REFUND_TO_SOURCE) which has not yet been posted.

Parameters

Parameter Description Required
refund_id The numeric ID of a refund with a status of SETUP or SCHEDULED (but not POSTED, DELETED or VOID) Yes

Comments

You must have the Financial Aid role to call this task.

deleteLicensePlate

Delete a person's license plate.

Parameters

Parameter Description Required
person_id The numeric ID of the person. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role to call deleteLicensePlate.

deletePersonBirthDate

Deletes the birth date for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Staff role to call this task.

deletePersonCitizenship

Deletes the citizenship for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Staff role to call this task.

deletePersonHometown

Deletes the hometown for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Staff role to call this task.

deletePersonRaceEthnicity

Deletes the race/ethnicity for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Staff role to call this task.

deletePersonSSN

Deletes the social security number for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have SSN editing permissions to call this task.

deletePhoneNumber

Deletes a phone number.

Parameters

Parameter Description Required
phoneid Numeric ID of the phone number. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role or else be deleting a phone number on his/her own profile.

deleteStudentDegreeSpecialization

Deletes a specialization attached to a student's degree.

Parameters

Parameter Description Required
person_id Numeric ID of the person you're interested in. Yes
degree_student_id Numeric ID of the degree_student object in question. Yes
specialization_id Numeric ID of the specialization you wish to remove. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Academic Admin or Registrar role to call this task.

deleteTodo

Deletes a todo.

Parameters

Parameter Description Required
todo_id The numeric ID of the todo you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

This function can only be used on todos 1) assigned to the currently logged-in user, 2) assigned by the currently logged-in user or 3) public todos attached to somone's profile if the currently logged-in user has the Staff role.

downloadBackup

Once a backup is ready for download, you can download it (as a ZIP file named backup_YEAR_MO_DY.zip) using this task.

Parameters

Parameter Description Required
backup_id The numeric ID of the backup you'd like to download. Yes

Example Response

Binary zip file data. The HTTP Content-disposition header will include the filename (e.g. backup_YYYY_MO_DY.zip).

Comments

Unlike most tasks in Populi's API, this function returns the actual binary data of a ZIP file rather than XML.

By specifying on_complete_url when calling requestBackup, you can have your own web application called as soon as the backup is ready for download. Your application can then call downloadBackup to get the ZIP file and encrypt and save it however you'd like.

downloadFile

Downloads the contents of a file.

Parameters

Parameter Description Required
file_id The numeric ID of the file you'd like to download. Yes

Example Response

The raw binary data for this file - the Content-Type HTTP header will indicate MIME type, and the Content-Disposition header will contain the file name.

Comments

Unlike most tasks, this one returns raw binary data rather than XML.

downloadStudentSchedule

Returns a PDF version of a student's schedule in a term.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
term_id The numeric ID of the academic term you're interested in. Yes

Comments

This task will return raw binary data rather than XML.

To call this task for anyone other than yourself, you must have the Registrar role, Academic Admin role, or be an advisor of the person.

editAidApplication

Edits an existing financial aid application.

Parameters

Parameter Description Required
aid_application_id The numeric ID of the aid application. Yes
assigned_to_id The numeric ID of the person to whom this aid application is assigned. No
enrollment The student's enrollment status (for financial aid purposes): FULL_TIME, THREE_QUARTER_TIME, HALF_TIME, or LESS_THAN_HALF_TIME No
dependency Whether this student is considered a dependent for aid purposes: can be blank, DEPENDENT, or INDEPENDENT No
student_aid_class_id The numeric aid class ID for this student (aid classes are how Populi groups similar types of students together). No
program_months The number of months this student is expected to be enrolled in your school's program. No
year_coa This student's Cost of Attendance if they were attending for the entire year (this should be extrapolated out from their program_coa for shorter programs, since Pell calculates based on COA for the entire year). No
program_coa This student's Cost of Attendance in this aid year. No
year_efc This student's Estimated Family Contribution in this aid year (extrapolated out to a full year for shorter programs, if necessary). No
program_efc This student's Estimated Family Contribution in this aid year. No
student_agi This student's Adjusted Gross Income in this aid year. No
parent_agi The parents' Adjusted Gross Income in this aid year. No
legal_residence_state The student's state of legal residence. No
verification Whether this student has been selected for verification. Must be either blank, SELECTED_BY_COLLEGE, or SELECTED_BY_GOVERNMENT. No
verification_status If this student was selected for verification (see above), what's their status? If set, must be one of: IN_PROGRESS, COMPLETED, REJECTED, or EXEMPTED. Cannot be set if `verification` is blank. No
verification_group If this student was selected for verification (see above), what verification group are they in? If set, must be one of: 'Standard, 'Child Support Paid', 'Custom', 'Aggregate', or 'Household Resources'. Cannot be set unless `verification` is set to SELECTED_BY_GOVERNMENT. No
auto_zero_efc Whether the student's EFC was calculated using the "automatic zero" EFC formula. If set, must be: 1 or 0 No
status The application status: SETUP, IN_PROGRESS, COMPLETED, NEEDS_ATTENTION, or CANCELED No
housing The student's housing situation: ON_CAMPUS, WITH_PARENT, or OFF_CAMPUS No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Financial Aid role to call this task.

If you don't set a field explicitly, its value will remain unchanged.

editFinancialAidAward

Edits an existing financial aid award.

Parameters

Parameter Description Required
award_id The numeric ID of an award. Yes
amount The total/gross amount of this award. Yes
net_amount The net amount of this award. Yes
status Possible values: SETUP, OFFERED, ACCEPTED, DECLINED, CANCELED. Yes
max_amount The maximum amount for this award. No

Comments

You must have the Financial Aid role to call this task.

editFinancialAidDisbursement

Edits an existing disbursement (only possible before it's posted).

Parameters

Parameter Description Required
disbursement_id The numeric ID of a disbursement. Yes
scheduled_date The anticipated disbursement date in the format '2012-10-10'. Yes
amount The net amount of this disbursement. Yes
gross_amount The gross net amount of this disbursement. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Financial Aid role to call this task.

editFinancialAidRefund

Edits an existing refund (only possible before it's posted).

Parameters

Parameter Description Required
refund_id The numeric ID of a refund. Yes
scheduled_date The anticipated disbursement date in the format '2012-10-10'. Yes
amount The net amount of this refund. Yes
type Possible options: REFUND_TO_STUDENT, REFUND_TO_SOURCE Yes
asset_account_id The ID of the asset account the money's coming from. Only applies to REFUND_TO_STUDENT type refunds. Yes (for REFUND_TO_STUDENT)

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Financial Aid role to call this task.

finalizeCourseInstance

Finalizes a course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course Faculty member to call this task.

getAcademicTerms

Returns all academic terms.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <academic_term>
        <termid>1111</termid>
        <name>Fall</name>
        <fullname>2010-2011: Fall</fullname>
        <start_date>2010-08-15</start_date>
        <end_date>2010-12-18</end_date>
        <yearid>222</yearid>
        <nonstandard>0</nonstandard>
    </academic_term>
    <academic_term>
        <termid>4444</termid>
        <name>Spring</name>
        <fullname>2010-2011: Spring</fullname>
        <start_date>2011-01-15</start_date>
        <end_date>2011-05-18</end_date>
        <yearid>222</yearid>
        <nonstandard>0</nonstandard>
  </academic_term>
    ...
</response>

Comments

None.

getAcademicYears

Returns all academic year IDs, as well as calendar years associated with each.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<academic_year>
<yearid>111</yearid>
<start_year>1901</start_year>
<end_year>1902</end_year>
</academic_year>
<academic_year>
<yearid>222</yearid>
<start_year>1902</start_year>
<end_year>1903</end_year>
</academic_year>
...
</response>

Comments

None.

getAidApplication

Returns a particular financial aid application (each student can have one per aid year).

Parameters

Parameter Description Required
aid_application_id The numeric ID of the aid application. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<aid_application>
<id>65</id>
<student_id>1000</student_id>
<aid_year_id>6</aid_year_id>
<aid_year_name>2009-2010</aid_year_name>
<assigned_to_id>0</assigned_to_id>
<assigned_to_name></assigned_to_name>
<dependency></dependency>
<student_aid_class_id></student_aid_class_id>
<student_aid_class_name></student_aid_class_name>
<program_months>9</program_months>
<enrollment>FULL_TIME</enrollment>
<year_coa>555.55</year_coa>
<program_coa>0.00</program_coa>
<year_efc>0.00</year_efc>
<program_efc>0.00</program_efc>
<student_agi>0.00</student_agi>
<parents_agi>0.00</parents_agi>
<auto_zero_efc>0</auto_zero_efc>
<fisap_total_income>0.00</fisap_total_income>
<legal_residence_state></legal_residence_state>
<need>0</need>
<housing></housing>
<status>SETUP</status>
<verification>SELECTED_BY_GOVERNMENT</verification>
<verification_status>IN_PROGRESS</verification_status>
<verification_group></verification_group>
<verification_exempt_reason></verification_exempt_reason>
<added_by_id>1257</added_by_id>
<added_at>2014-12-17 10:47:56</added_at>
</aid_application>
</response>

Comments

You must have one of these roles to call this task: Financial Aid, Student Billing, or Financial Admin.

getAidApplicationForStudentAidYear

Returns a particular financial aid application (each student can have one per aid year).

Parameters

Parameter Description Required
student_id The numeric ID of the student. Yes
aid_year_id The numeric ID of the aid year. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<aid_application>
<id>65</id>
<student_id>1000</student_id>
<aid_year_id>6</aid_year_id>
<aid_year_name>2009-2010</aid_year_name>
<assigned_to_id>0</assigned_to_id>
<assigned_to_name></assigned_to_name>
<dependency></dependency>
<student_aid_class_id></student_aid_class_id>
<student_aid_class_name></student_aid_class_name>
<program_months>9</program_months>
<enrollment>FULL_TIME</enrollment>
<year_coa>555.55</year_coa>
<program_coa>0.00</program_coa>
<year_efc>0.00</year_efc>
<program_efc>0.00</program_efc>
<student_agi>0.00</student_agi>
<parents_agi>0.00</parents_agi>
<auto_zero_efc>0</auto_zero_efc>
<fisap_total_income>0.00</fisap_total_income>
<legal_residence_state></legal_residence_state>
<need>0</need>
<housing></housing>
<status>SETUP</status>
<verification>SELECTED_BY_GOVERNMENT</verification>
<verification_status>IN_PROGRESS</verification_status>
<verification_group></verification_group>
<verification_exempt_reason></verification_exempt_reason>
<added_by_id>1257</added_by_id>
<added_at>2014-12-17 10:47:56</added_at>
</aid_application>
</response>

Comments

You must have one of these roles to call this task: Financial Aid, Student Billing, or Financial Admin.

getAllCustomFields

Returns all custom fields your college has defined.

Parameters

Parameter Description Required
type ALL (default), APPLICATION, FACULTY, PERSON, PROSPECT, STUDENT No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<custom_field>
<id>111</id>
<name>Dorm Preference</name>
<description>
Quickly deliver enterprise-wide best practices rather than cross-media vortals.
Enthusiastically predominate goal-oriented process improvements after fully tested niches.
Globally fabricate ubiquitous content after synergistic web-readiness.
</description>
<type>STUDENT</type>
<input_type>SELECT</input_type>
</custom_field>
<custom_field>
<id>555</id>
<name>Number of Previous Colleges Attended</name>
<description>
Collaboratively leverage other's mission-critical networks before accurate processes.
Competently deliver multidisciplinary information before B2C intellectual capital.
Phosfluorescently embrace sticky outsourcing without cross-unit customer service.
</description>
<type>APPLICATION</type>
<input_type>INTEGER</input_type>
</custom_field>
...
</response>

Comments

You must have the Staff role to call this task.

<input_type> can be:

  • DATE - e.g. 2010-09-09
  • DATE_TIME- e.g. 2010-09-09 19:00:45
  • DECIMAL - e.g. 10.88
  • CHECKBOX - Allows multiple values to be selected from a list
  • FILE - a numeric file_id (e.g. 11111)
  • INTEGER - e.g. 101
  • RADIO - Select one from a list of a few options
  • SELECT - Select one from a list of many options
  • TEXT_AREA - Lots of text
  • TEXT - Little bit of text

getApplication

Returns an application.

Parameters

Parameter Description Required
application_id Numeric ID of the application you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<application>
<id>54321</id>
<person_id>1234</person_id>
<lead_id>3214</lead_id>
<first_name>Carl</first_name>
<middle_name>Allen</middle_name>
<last_name>Michaelson</last_name>
<email>carl@email.org</email>
<application_template_id>164</application_template_id>
<representative_id>2068</representative_id>
<program_id>26</program_id>
<degree_seeking>1</degree_seeking>
<degree_id>24</degree_id>
<specialization_id>0</specialization_id>
<academic_term_id>190</academic_term_id>
<expected_enrollment>FULL_TIME</expected_enrollment>
<status>IN_PROGRESS</status>
<started_on>2014-02-07</started_on>
<submitted_at></submitted_at>
<decision_on></decision_on>
<withdrawn_on></withdrawn_on>
<provisional>0</provisional>
<provisional_comment></provisional_comment>
<fee_status>UNPAID</fee_status>
<fee_id></fee_id>
<fee_amount></fee_amount>
<fee_payment>BEFORE_START</fee_payment>
<applicant_activity_at>2014-02-10 15:46:35</applicant_activity_at>
<staff_activity_at>2014-02-10 16:10:45</staff_activity_at>
<percent_completed>100</percent_completed>
<sections>
<heading>
<content>Personal Information</content>
<order_id>1</order_id>
</heading>
<text>
<content>Tell us about yourself.</content>
<order_id>2</order_id>
<files>
<file>
<file_id>9355</file_id>
<name>terms.doc</name>
</file>
</files>
</text>
<field>
<id>19</id>
<name>Home Address</name>
<description></description>
<is_required>1</is_required>
<data_type>ADDRESS</data_type>
<data_format></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>0</has_options>
<order_id>3</order_id>
<answer>
<street>123 Any St</street>
<city>Anytown</city>
<state>ID</state>
<zip>12345</zip>
<country>USA</country>
</answer>
</field>
<field>
<id>20</id>
<name>SSN</name>
<description>Please enter your social security number.</description>
<is_required>0</is_required>
<data_type>NUMBER</data_type>
<data_format>SOCIAL_SECURITY_NUMBER</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>0</has_options>
<order_id>4</order_id>
</field>
<field>
<id>21</id>
<name>Hobbies and Interests</name>
<description>Choose any two of the following options.</description>
<is_required>1</is_required>
<data_type>MULTIPLE_ANSWER</data_type>
<data_format></data_format>
<max_multiple_answers>2</max_multiple_answers>
<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>5</order_id>
<answer>
<index_0>527</index_0>
<index_1>529</index_1>
</answer>
</field>
...
</sections>
</application>
</response>

Comments

You must have the Admissions role or be the owner of the application to call this task.

getApplicationComponents

Returns all application components for a particular application.

Parameters

Parameter Description Required
application_id The numeric ID of the application you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<component>
<id>1111</id>
<content>Educational History</content>
<received_date>2008-04-15</received_date>
<status>ACCEPTED</status>
</component>
<component>
<id>1112</id>
<content>Please write us a 5-10 page essay on the topic of your choice.</content>
<received_date>2008-04-15</received_date>
<status>ACCEPTED</status>
</component>
<component>
<id>1113</id>
<name>Letter of Recommendation</name>
<received_date>2008-04-15</received_date>
<status>ACCEPTED</status>
</component>
...
</response>

Comments

You must have the Staff role to call this task.

getApplicationFieldOptions

Returns the options for an application field.

Parameters

Parameter Description Required
application_field_id Numeric ID of the application field you're interested in. Yes
country USA, CAN. No, but if you're requesting options for a field with the data_format STATE_PROVINCE you must include this.
degree_id Numeric ID of a degree. No, but if you're requesting options for a field with the data_format SPECIALIZATION you must include this.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<application_field_options>
<option>
<id>528</id>
<name>Baseball</name>
</option>
<option>
<id>537</id>
<name>Softball</name>
</option>
<option>
<id>527</id>
<name>Football</name>
</option>
<option>
<id>529</id>
<name>Soccer</name>
</option>
<option>
<id>536</id>
<name>Tennis</name>
</option>
...
</application_field_options>
</response>

Comments

Only application fields with a data_type of CHOICE or MULTIPLE_ANSWER will return options.

getApplicationTemplates

Returns all application templates.

Parameters

Parameter Description Required
show_online_only Boolean. Default false. If true only application templates that are set to show online will be returned. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<application_template>
<id>112</id>
<name>Basic</name>
<show_online>0</show_online>
<fee_amount></fee_amount>
<fee_payment>BEFORE_START</fee_payment>
<allow_undecided>1</allow_undecided>
</application_template>
<application_template>
<id>114</id>
<name>Standard</name>
<show_online>1</show_online>
<fee_amount>50</fee_amount>
<fee_payment>BEFORE_START</fee_payment>
<allow_undecided>1</allow_undecided>
<programs>
<program>
<id>26</id>
<name>Undergraduate</name>
</program>
<program>
<id>27</id>
<name>Graduate</name>
</program>
</programs>
<academic_terms>
<academic_term>
<id>194</id>
<name>2015-2016: Spring</name>
</academic_term>
<academic_term>
<id>189</id>
<name>2015-2016: Winter</name>
</academic_term>
<academic_term>
<id>190</id>
<name>2015-2016: Fall</name>
</academic_term>
</academic_terms>
<enrollment_options>
<enrollment_option>FULL_TIME</enrollment_option>
<enrollment_option>HALF_TIME</enrollment_option>
<enrollment_option>LESS_THAN_HALF_TIME</enrollment_option>
</enrollment_options>
</application_template>
...
</response>

Comments

You must have the Admissions role to call this task.

If the application template is set up with programs, academic terms, or enrollment the available options will be returned in <programs>, <academic_terms> and <enrollment_options> elements.

getApplications

Returns applications based on the filter conditions.

Parameters

Parameter Description Required
date_field The name of the date field you want to filter by (e.g. APPLIED, DECISION, SUBMITTED, or WITHDRAWN). No
start_date The start date used to filter the "date_field" parameter. No
end_date The end date used to filter the "date_field" parameter. No
term_id The numeric ID of the academic term you're interested in. No
program_id The numeric ID of the program you're interested in. No
degree_id The numeric ID of the degree you're interested in. No
specialization_id The numeric ID of the specialization you're interested in. No
offset The numeric value you want to offset the results by. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response num_results="356">
<application>
<id>1111</id>
<person_id>2222</person_id>
<first_name>Robert</first_name>
<last_name>Jones</last_name>
<preferred_name>Bob</preferred_name>
<gender>MALE</gender>
<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>
<full_time>1</full_time>
<term_id>6666</term_id>
<term_name>Fall Term 2008-2009</term_name>
<applied_date>2008-03-28</applied_date>
<submitted_date>2008-03-28</submitted_date>
<decision_date>2008-04-13</decision_date>
<withdrawn_date/>
<submitted_type>ONLINE</submitted_type>
<provisional>0</provisional>
<provisional_comment/>
<num_days_since_last_activity>15</num_days_since_last_activity>
<percent_completed>100</percent_completed>
<status>ACCEPTED</status>
</application>
<application>
<id>1130</id>
<person_id>2230</person_id>
<first_name>Christa</first_name>
<last_name>Williams</last_name>
<preferred_name/>
<gender>FEMALE</gender>
<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>
<full_time>1</full_time>
<term_id>6666</term_id>
<term_name>Fall Term 2008-2009</term_name>
<applied_date>2008-03-02</applied_date>
<submitted_date>2008-03-02</submitted_date>
<decision_date>2008-03-15</decision_date>
<withdrawn_date/>
<submitted_type>ONLINE</submitted_type>
<provisional>0</provisional>
<provisional_comment/>
<num_days_since_last_activity>3</num_days_since_last_activity>
<percent_completed>90</percent_completed>
<status>COLLECTION</status>
</application>
...
</response>

Comments

You must have the Admissions role to call this task.

The "start_date" and "end_date" parameters are required when filtering by the "date_field" parameter.

There is a limit of 200 results in the response.

The "num_results" attribute in the <response> element indicates the total number of results regardless of the limit or offset.

getAvailableRoles

Returns all the roles in Populi (Student, Staff, Admissions, etc).

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<role>
<id>1234</id>
<name>Academic Admin</name>
</role>
<role>
<id>12345</id>
<name>Admissions</name>
</role>
<role>
<id>123456</id>
<name>Advisor</name>
</role>
...
</response>

Comments

Useful if you'd like to give someone a role but need to know its numeric role_id.

getCommunicationPlans

Returns all available communication plans.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <communication_plan>
        <id>13</id>
        <name>Leads Communication Plan</name>
        <added_by>3093</added_by>
        <added_at>2017-02-08 22:09:27</added_at>
    </communication_plan>
    ...
</response>

Comments

The current user must have the Staff role to call this task.

getCountries

Returns a list of countries and their respective abbreviations.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<countries>
		<country>
			<abbreviation>USA</abbreviation>
			<name>United States of America</name>
		</country>
		<country>
			<abbreviation>CA</abbreviation>
			<name>Canada</name>
		</country>
		...
	</countries>
</response>

Comments

You must have the Staff role to call this task.

getCourseCatalog

Returns courses from your catalog (only active courses are returned by default).

Parameters

Parameter Description Required
include_retired If set to 1, retired courses will be returned as well. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<course>
<courseid>11111</courseid>
<name>Advanced Writing: The Novel</name>
<abbrv>ENG400</abbrv>
<description>You'd want to take ENG400 because...</description>
<credits>3.00</credits>
<hours>0.00</hours>
<status>ACTIVE</status>
<deptid>1</deptid>
<dept_name>Humanities</dept_name>
<programs>
<program>
<id>2222</id>
<name>Undergraduate</name>
</program>
</programs>
</course>
<course>
<courseid>22222</courseid>
<name>Calculus I</name>
<abbrv>MAT201</abbrv>
<description>You'd want to take Calculus because...</description>
<credits>0.00</credits>
<hours>20.00</hours>
<status>ACTIVE</status>
<deptid>2</deptid>
<dept_name>Sciences</dept_name>
<programs>
<program>
<id>2222</id>
<name>Undergraduate</name>
</program>
<program>
<id>3333</id>
<name>Registered Nursing</name>
</program>
</programs>
</course>
...
</response>

Comments

Useful for automatically syncing your course catalog to your website.

getCourseGroupInfo

Returns information about a course group.

Parameters

Parameter Description Required
course_group_id The numeric ID of the course group you're interested in. Yes
academic_year_id The numeric ID of the academic year you're interested in. Defaults to the current academic year ID. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<catalog_courses>
		<catalog_course>
			<id>98434</id>
			<abbreviation>ENG101</abbreviation>
			<name>English 101</name>
			<credits>2.00</credits>
			<hours>3.00</hours>
			<department_id>2986</department_id>
			<department_name>English</department_name>
		</catalog_course>
		<catalog_course>
			<id>98435</id>
			<abbreviation>ENG102</abbreviation>
			<name>English 102</name>
			<credits>2.00</credits>
			<hours>3.00</hours>
			<department_id>2986</department_id>
			<department_name>English</department_name>
		</catalog_course>
		...
	</catalog_courses>
	<degrees_requiring_course_group>
		<degree>
			<id>1</id>
			<abbreviation>A.A.</abbreviation>
			<name>Bachelor of Arts</name>
		</degree>
		<degree>
			<id>2</id>
			<abbreviation>A.A.</abbreviation>
			<name>Associate of Arts</name>
		</degree>
		...
	</degrees_requiring_course_group>
	<specializations_requiring_course_group>
		<specialization>
			<id>513</id>
			<abbreviation>ENG</abbreviation>
			<name>English</name>
		</specialization>
		<specialization>
			<id>436</id>
			<abbreviation>MUS</abbreviation>
			<name>Music</name>
		</specialization>
		...
	</specializations_requiring_course_group>
</response>

Comments

You must have the Academic Admin, Registrar, or Academic Auditor role to call this task.

getCourseGroups

Returns a list of course groups.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<course_groups>
		<course_group>
			<id>1</id>
			<abbreviation>CORE</abbreviation>
			<name>Core Curriculum</name>
		</course_group>
		<course_group>
			<id>2</id>
			<abbreviation>ENG</abbreviation>
			<name>English</name>
		</course_group>
		...
	</course_groups>
</response>

Comments

You must have the Academic Admin, Registrar, or Academic Auditor role to call this task.

getCourseInstance

A course instance is created each time a course from the catalog is offered in a particular term. If the same catalog course is offered multiple times in the same term, each instance will have a unique section number.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <instanceid>44444</instanceid>
    <name>Calculus I</name>
    <abbrv>MAT201</abbrv>
    <section>3</section>
    <credits>3.00</credits>
    <hours>9.00</hours>
    <affects_earned_credits>1</affects_earned_credits>
    <description>Calculus I is the stepping stone into the world of higher mathematics...</description>
    <pass_fail>0</pass_fail>
    <finalized>0</finalized>
    <termid>777</termid>
    <term_name>Spring Term 2009-2010</term_name>
    <allow_auditor_assignments>0</allow_auditor_assignments>
    <allow_auditor_attendance>0</allow_auditor_attendance>
    <schedule>
        <start_time>8:00am</start_time>
        <end_time>9:00am</end_time>
        <room>Room TBA</room>
        <building></building>
        <weekdays>
            <day>MO</day>
            <day>TU</day>
            <day>WE</day>
            <day>TH</day>
            <day>FR</day>
        </weekdays>
    </schedule>
    <faculty>
        <person>
            <primary>1</primary>
            <personid>1001</personid>
            <first>Robert</first>
            <last>McProfessor</last>
            <preferred>Bob</preferred>
            <displayname>Bob McProfessor</displayname>
            <is_teaching_assistant>0</is_teaching_assistant>
        </person>
        <person>
            <primary>0</primary>
            <personid>554</personid>
            <first>Jimmy</first>
            <last>McTeachingAssistant</last>
            <preferred></preferred>
            <displayname>Jimmy McTeachingAssistant</displayname>
            <is_teaching_assistant>1</is_teaching_assistant>
        </person>
    </faculty>
</response>

Comments

To get more detail about a course instance see: getCourseInstanceStudents, getCourseInstanceAssignmentGroups, getCourseInstanceFiles, getCourseInstanceLessons, and getCourseInstanceMeetings

getCourseInstanceAssignmentGroups

Assignment groups are worth a fixed percentage of the course (e.g. Quizzes are worth 10% of each student's final grade), and you can then add as many assignments within the Quizzes group as you like, or even add new assignments to the group part-way through the term, and be guaranteed that the value of all those assignments together will still equal 10% of the course.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <assignment_group>
        <groupid>7777</groupid>
        <name>Quizzes</name>
        <weight_percent>10</weight_percent>
        <extra_credit>0</extra_credit>
        <drop_lowest>0</drop_lowest>
    </assignment_group>
    <assignment_group>
        <groupid>4444</groupid>
        <name>Tests</name>
        <weight_percent>60</weight_percent>
        <extra_credit>0</extra_credit>
        <drop_lowest>0</drop_lowest>
    </assignment_group>
    <assignment_group>
        <groupid>3333</groupid>
        <name>Participation</name>
        <weight_percent>30</weight_percent>
        <extra_credit>0</extra_credit>
        <drop_lowest>0</drop_lowest>
    </assignment_group>
    <assignment_group>
        <groupid>0</groupid>
        <name>Other</name>
        <weight_percent>0</weight_percent>
        <extra_credit>0</extra_credit>
        <drop_lowest>0</drop_lowest>
    </assignment_group>
</response>

Comments

Even if no assignment groups are set up, a default assignment group of "Other" with a <groupid> of 0 will always be returned (and worth 100% of the course).

getCourseInstanceAssignments

Returns information about each assignment in a course - including which Assignment Group it belongs to.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<assignment>
		<assignmentid>111</assignmentid>
		<name>Quiz #1</name>
		<points>10</points>
		<type>TEST</type>
		<percent_of_course>5.00000000</percent_of_course>
		<groupid>7777</groupid>
		<group_name>Quizzes</group_name>
		<extra_credit>0</extra_credit>
		<description></description>
		<discussion_id></discussion_id>
		<visible_to_students_before_due>1</visible_to_students_before_due>
		<start_window>2017-07-20T00:00:00-07:00</start_window>
		<end_window>2017-08-20T00:00:00-07:00</end_window>
		<time_limit>60</time_limit>
		<retake_policy>KEEP_HIGHEST</retake_policy>
		<retakes>1</retakes>
		<answers_visible>AFTER_TAKING</answers_visible>
		<proctored>1</proctored>
		<student_info>
			<person_id>3093</person_id>
			<student_id>2010000043</student_id>
			<first_name>James</first_name>
			<last_name>McMcintosh</last_name>
			<preferred_name>Jimmy</preferred_name>
			<submitted_assignment_data>1</submitted_assignment_data>
			<grade>95</grade>
			<letter_grade>A</letter_grade>
		</student_info>
		...
	</assignment>
	<assignment>
		<assignmentid>222</assignmentid>
		<name>Peer Review</name>
		<points>10</points>
		<type>PEER_REVIEW_FILE_UPLOAD</type>
		<percent_of_course>5.00000000</percent_of_course>
		<groupid>7777</groupid>
		<group_name>Quizzes</group_name>
		<extra_credit>0</extra_credit>
		<description></description>
		<discussion_id></discussion_id>
		<visible_to_students_before_due>1</visible_to_students_before_due>
		<time_due>2017-07-20T00:00:00-07:00</time_due>		
		<peer_grade>1</peer_grade>
		<grade_submissions>100</grade_submissions>
		<grade_reviews>100</grade_reviews>
		<anonymous_reviews>0</anonymous_reviews>
		<review_visibility>NEVER</review_visibility>
		<allow_review_comments>allow_review_comments</allow_review_comments>
		<reviews_due_time>2017-07-20T00:00:00-07:00</reviews_due_time>
		<reviews_closed_time>2017-07-20T00:00:00-07:00</reviews_closed_time>
		<student_info>
			<person_id>3093</person_id>
			<student_id>2010000043</student_id>
			<first_name>James</first_name>
			<last_name>McMcintosh</last_name>
			<preferred_name>Jimmy</preferred_name>
			<submitted_assignment_data>1</submitted_assignment_data>
			<grade>95</grade>
			<letter_grade>A</letter_grade>
		</student_info>
		...
	</assignment>
	<assignment>
		<assignmentid>21498</assignmentid>
		<name>Big Bad Exam</name>
		<points>100</points>
		<type>GRADE_ONLY</type>
		<percent_of_course>90.00000000</percent_of_course>
		<groupid>0</groupid>
		<group_name>Other</group_name>
		<extra_credit>0</extra_credit>
		<description></description>
		<discussion_id></discussion_id>
		<visible_to_students_before_due>1</visible_to_students_before_due>
		<time_due>2017-07-20T00:00:00-07:00</time_due>
		<student_info>
			<person_id>3093</person_id>
			<student_id>2010000043</student_id>
			<first_name>James</first_name>
			<last_name>McMcintosh</last_name>
			<preferred_name>Jimmy</preferred_name>
			<submitted_assignment_data>0</submitted_assignment_data>
		</student_info>
		...
	</assignment>
</response>

Comments

Every assignment is attached to an Assignment Group - even if it's only the default "Other" group (which has a groupid of 0).

The "student_info" data will only be returned if you have the Academic Admin role, the Registrar role, or you are a course Faculty member.

getCourseInstanceFiles

Returns the files attached to a course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<file>
<file_id>55555</file_id>
<name>ChemicalBonds.jpg</name>
<content_type>image/jpeg</content_type>
</file>
</response>

Comments

See downloadFile.

getCourseInstanceLessons

Returns the lessons attached to a course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<lesson>
<lessonid>1111</lessonid>
<name>Lesson #1</name>
<available_at>2010-09-30 00:00:00</available_at>
<is_available>1</is_available>
<num_discussions>2</num_discussions>
<num_new_posts>0</num_new_posts>
</lesson>
<lesson>
<lessonid>1112</lessonid>
<name>Lesson #2</name>
<available_at>2010-10-07 00:00:00</available_at>
<is_available>1</is_available>
<num_discussions>3</num_discussions>
<num_new_posts>2</num_new_posts>
</lesson>
...
</response>

Comments

See getLessonContent to get the HTML content of each lesson.

getCourseInstanceMeetingAttendance

Gets attendance for a course instance meeting.

Parameters

Parameter Description Required
instanceID The numeric ID of the course instance you're interested in. Yes
meetingID The numeric ID of the meeting. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<attendee>
<personid>1234</personid>
<status>TARDY</status>
</attendee>
<attendee>
<personid>1235</personid>
<status>PRESENT</status>
</attendee>
</response>

getCourseInstanceMeetings

Returns the meetings attached to a course instance.

Parameters

Parameter Description Required
instanceID The numeric ID of the course instance you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <meeting>
        <meetingid>667</meetingid>
        <roomid>15687</roomid>
        <room_name>School Building: 101</room_name>
        <start>2016-03-21T08:00:00-07:00</start>
        <end>2016-03-21T09:00:00-07:00</end>
        <counts_toward_attendance_hours>0</counts_toward_attendance_hours>
        <counts_toward_clinical_hours>0</counts_toward_clinical_hours>
    </meeting>
    <meeting>
        <meetingid>668</meetingid>
        <roomid>0</roomid>
        <room_name>TBA</room_name>
        <start>2016-04-23T08:00:00-07:00</start>
        <end>2016-04-23T09:00:00-07:00</end>
        <counts_toward_attendance_hours>0</counts_toward_attendance_hours>
        <counts_toward_clinical_hours>0</counts_toward_clinical_hours>
    </meeting>
    <meeting>
        <roomid>0</roomid>
        <room_name>TBA</room_name>
        <start>2016-05-23T08:00:00-07:00</start>
        <end>2016-05-23T09:00:00-07:00</end>
        <counts_toward_attendance_hours>0</counts_toward_attendance_hours>
        <counts_toward_clinical_hours>0</counts_toward_clinical_hours>
    </meeting>
</response>

Comments

If meetingid is 0 then no attendance has been taken for that meeting time.

getCourseInstanceStudentAttendance

Gets attendance for all course instance meetings for a particular student.

Parameters

Parameter Description Required
instanceID The numeric ID of the course instance you're interested in. Yes
person_id Numeric ID of the person whose attendance you wish to look up. Yes

Example Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<response>
    <attendee>
        <meetingid>42696</meetingid>
        <start>2017-08-02 08:00:00</start>
        <end>2017-08-02 10:00:00</end>
        <summary>BIO-101</summary>
        <status>PRESENT</status>
    </attendee>
    <attendee>
        <meetingid>42699</meetingid>
        <start>2017-08-06 08:00:00</start>
        <end>2017-08-06 10:00:00</end>
        <summary>BIO-101</summary>
        <status>EXCUSED</status>
    </attendee>
</response>

Comments

You must have edit access to the specified course instance to call this task.

getCourseInstanceStudents

Returns all students enrolled, auditing, incomoplete, or withdrawn in this course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<courseinstance_student>
<status>ENROLLED</status>
<personid>4004</personid>
<first>Christopher</first>
<last>Anderson</last>
<preferred/>
<start_date>2010-05-05</start_date>
<grade>92</grade>
<letter_grade>A-</letter_grade>
<attendance>94</attendance>
</courseinstance_student>
<courseinstance_student>
<status>AUDITOR</status>
<personid>8000</personid>
<first>George</first>
<last>Washington</last>
<preferred>Jerry</preferred>
<start_date>2010-05-16</start_date>
</courseinstance_student>
...
</response>

Comments

Possible values for the status element are: ENROLLED, AUDITOR, WITHDRAWN, or INCOMPLETE. Note that there are some additional elements returned if the student is ENROLLED: grade, letter_grade, and attendance (both grade and attendance are percentages: so 97 mean 97%).

The <start_date> element represents the day the student started his or her current status... so if Jerry enrolled in the course on April 1 but then switched to auditing on May 16, his <status> would be AUDITOR and his <start_date> would be May 16.

getCourseOfferingLinks

Returns links attached to a particular course offering.

Parameters

Parameter Description Required
course_offering_id The numeric ID of the course offering you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <links>
    	<link>
    		<id>1<id>
    		<name>Library of Congress<name>
    		<url>https://www.loc.gov/<url>
	    </link>
	    ...
    </links>
</response>

getCurrentAcademicTerm

Returns the current academic term.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <termid>1111</termid>
    <name>Fall</name>
    <fullname>2010-2011: Fall</fullname>
    <start_date>2010-08-15</start_date>
    <end_date>2010-12-18</end_date>
    <yearid>222</yearid>
    <nonstandard>0</nonstandard>
</response>

Comments

None.

getCustomFieldOptions

Returns available options for RADIO, CHECKBOX, and SELECT input type custom fields.

Parameters

Parameter Description Required
custom_field_id The numeric ID of the custom field you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<option>
<index>1</index>
<name>Hadley Hall</name>
</option>
<option>
<index>2</index>
<name>Williams Dorm</name>
</option>
<option>
<index>4</index>
<name>McIntyre Commons</name>
</option>
...
</response>

Comments

You must have the Staff role to call this task.

The <index> of an option is not a unique ID - two different custom fields might each have an option with an index of 4.

getCustomFields

Returns custom fields attached to a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
type ALL (default), APPLICATION, FACULTY, PERSON, PROSPECT, STUDENT No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <custom_field>
        <id>3333333</id>
        <name>Dorm Preference</name>
        <type>PERSON</type>
        <input_type>SELECT</input_type>
        <value>Robinson Hall</value>
        <option_index>2</option_index>
    </custom_field>
    <custom_field>
        <id>22222</id>
        <name>Joe Brown Scholarship Application Essay</name>
        <type>APPLICATION</type>
        <input_type>TEXT_AREA</input_type>
        <value>Interactively deliver superior intellectual capital...</value>
    </custom_field>
    ...
</response>

Comments

You must have the Staff role to call this task.

For more information about <input_type> see getAllCustomFields

For RADIO, CHECKBOX, and SELECT input types, notice that a numeric <option_index> is returned in addition to the <value> (this corresponds to the <index> returned by getCustomFieldOptions).

getDegreeAudit

Returns the degree audit for a particular student.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
degree_id The numeric ID of the degree you're interested in. Yes
academic_year_id The numeric ID of the academic year you're interested in. Yes
specialization_id The numeric ID of the specialization you're interested in. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <degree>
        <all_requirements_completed>1</all_requirements_completed>
        <cumulative_gpa_required>3.00</cumulative_gpa_required>
        <cumulative_gpa>3.40</cumulative_gpa>
        <cumulative_gpa_requirement_completed>1</cumulative_gpa_requirement_completed>
        <overall_gpa_required>3.00</overall_gpa_required>
        <overall_gpa>3.40</overall_gpa>
        <overall_gpa_requirement_completed>1</overall_gpa_requirement_completed>
        <cumulative_units_required>120.00</cumulative_units_required>
        <cumulative_units>120.00</cumulative_units>
        <cumulative_units_requirement_completed>1</cumulative_units_requirement_completed>
        <resident_units_required>120.00</resident_units_required>
        <resident_units>120.00</resident_units>
        <resident_units_requirement_completed>1</resident_units_requirement_completed>
        <cumulative_clinical_hours_required>0.00</cumulative_clinical_hours_required>
        <cumulative_clinical_hours>0.00</cumulative_clinical_hours>
        <cumulative_clinical_hours_requirement_completed>
        	1
        </cumulative_clinical_hours_requirement_completed>
        <resident_clinical_hours_required>0.00</resident_clinical_hours_required>
        <resident_clinical_hours>0.00</resident_clinical_hours>
        <resident_clinical_hours_requirement_completed>
        	1
        </resident_clinical_hours_requirement_completed>
        <cumulative_attendance_hours_required>0.00</cumulative_attendance_hours_required>
        <cumulative_attendance_hours>0.00</cumulative_attendance_hours>
        <cumulative_attendance_hours_requirement_completed>
        	1
        </cumulative_attendance_hours_requirement_completed>
        <resident_attendance_hours_required>0.00</resident_attendance_hours_required>
        <resident_attendance_hours>0.00</resident_attendance_hours>
        <resident_attendance_hours_requirement_completed>
        	1
        </resident_attendance_hours_requirement_completed>
        <in_progress_units>0.00</in_progress_units>
        <in_progress_clinical_hours>0.00</in_progress_clinical_hours>
        <in_progress_attendance_hours>0.00</in_progress_attendance_hours>
        <course_groups>
            <course_group>
                <id>846</id>
                <name>English</name>
                <all_requirements_completed>1</all_requirements_completed>
                <requirement_type>UNITS</requirement_type>
                <requirement_value>12.00</requirement_value>
                <earned_requirements>12.00</earned_requirements>
                <transferred_requirements>0.00</transferred_requirements>
                <general_requirements_completed>1</general_requirements_completed>
                <required_gpa>3.00</required_gpa>
                <gpa>3.40</gpa>
                <gpa_requirements_completed>1</gpa_requirements_completed>
                <waived_requirements>0.00</waived_requirements>
                <exceptions_applied>0</exceptions_applied>
                <completed_courses>
                    <completed_course>
                        <catalog_course_id>98434</catalog_course_id>
                        <abbreviation>ENG101</abbreviation>
                        <name>English 101</name>
                        <grade>A</grade>
                        <status>2 credits completed</status>
                        <course_offering_id>4681354</course_offering_id>
                        <transfer_credit_id></transfer_credit_id>
                        <fulfilled_by_abbreviation></fulfilled_by_abbreviation>
                        <fulfilled_by_name></fulfilled_by_name>
                    </completed_course>
                    ...
                </completed_courses>
                <incomplete_courses>
                    <incomplete_course>
                        <catalog_course_id>98435</catalog_course_id>
                        <abbreviation>ENG102</abbreviation>
                        <name>English 102</name>
                    </incomplete_course>
                    ...
                </incomplete_courses>
            </course_group>
            ...
        </course_groups>
    </degree>
    <specialization>
        <all_requirements_completed>1</all_requirements_completed>
        <cumulative_gpa_required>3.00</cumulative_gpa_required>
        <cumulative_gpa>3.40</cumulative_gpa>
        <cumulative_gpa_requirement_completed>1</cumulative_gpa_requirement_completed>
        <overall_gpa_required>3.00</overall_gpa_required>
        <overall_gpa>3.40</overall_gpa>
        <overall_gpa_requirement_completed>1</overall_gpa_requirement_completed>
        <cumulative_units_required>120.00</cumulative_units_required>
        <cumulative_units>120.00</cumulative_units>
        <cumulative_units_requirement_completed>1</cumulative_units_requirement_completed>
        <resident_units_required>120.00</resident_units_required>
        <resident_units>120.00</resident_units>
        <resident_units_requirement_completed>1</resident_units_requirement_completed>
        <cumulative_clinical_hours_required>0.00</cumulative_clinical_hours_required>
        <cumulative_clinical_hours>0.00</cumulative_clinical_hours>
        <cumulative_clinical_hours_requirement_completed>
        	1
        </cumulative_clinical_hours_requirement_completed>
        <resident_clinical_hours_required>0.00</resident_clinical_hours_required>
        <resident_clinical_hours>0.00</resident_clinical_hours>
        <resident_clinical_hours_requirement_completed>
        	1
        </resident_clinical_hours_requirement_completed>
        <cumulative_attendance_hours_required>0.00</cumulative_attendance_hours_required>
        <cumulative_attendance_hours>0.00</cumulative_attendance_hours>
        <cumulative_attendance_hours_requirement_completed>
        	1
        </cumulative_attendance_hours_requirement_completed>
        <resident_attendance_hours_required>0.00</resident_attendance_hours_required>
        <resident_attendance_hours>0.00</resident_attendance_hours>
        <resident_attendance_hours_requirement_completed>
        	1
        </resident_attendance_hours_requirement_completed>
        <in_progress_units>0.00</in_progress_units>
        <in_progress_clinical_hours>0.00</in_progress_clinical_hours>
        <in_progress_attendance_hours>0.00</in_progress_attendance_hours>
        <course_groups>
            <course_group>
                <id>846</id>
                <name>English</name>
                <all_requirements_completed>1</all_requirements_completed>
                <requirement_type>UNITS</requirement_type>
                <requirement_value>12.00</requirement_value>
                <earned_requirements>12.00</earned_requirements>
                <transferred_requirements>0.00</transferred_requirements>
                <general_requirements_completed>1</general_requirements_completed>
                <required_gpa>3.00</required_gpa>
                <gpa>3.40</gpa>
                <gpa_requirements_completed>1</gpa_requirements_completed>
                <waived_requirements>0.00</waived_requirements>
                <exceptions_applied>0</exceptions_applied>
                <completed_courses>
                    <completed_course>
                        <catalog_course_id>98434</catalog_course_id>
                        <abbreviation>ENG101</abbreviation>
                        <name>English 101</name>
                        <grade>A</grade>
                        <status>2 credits completed</status>
                        <course_offering_id>4681354</course_offering_id>
                        <transfer_credit_id></transfer_credit_id>
                        <fulfilled_by_abbreviation></fulfilled_by_abbreviation>
                        <fulfilled_by_name></fulfilled_by_name>
                    </completed_course>
                    ...
                </completed_courses>
                <incomplete_courses>
                    <incomplete_course>
                        <catalog_course_id>98435</catalog_course_id>
                        <abbreviation>ENG102</abbreviation>
                        <name>English 102</name>
                    </incomplete_course>
                    ...
                </incomplete_courses>
            </course_group>
            ...
        </course_groups>
    </specialization>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

getDegrees

Returns information about each degree configured at the school.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <degree>
        <id>5322</id>
        <name>A.A. in Music</name>
        <abbrv>UG</abbrv>
        <program_id>27</program_id>
        <program_name>Undergraduate</program_name>
        <department_id>12</department_id>
        <department_name>Music</department_name>
        <status>ACTIVE</status>
        <graduate>0</graduate>
        <length>2</length>
        <length_unit>YEARS</length_unit>
        <specializations></specializations>
    </degree>
    <degree>
        <id>9223</id>
        <name>B.A. in History</name>
        <abbrv>G.</abbrv>
        <program_id>27</program_id>
        <program_name>Graduate</program_name>
        <department_id>45</department_id>
        <department_name>Humanities</department_name>
        <status>RETIRED</status>
        <graduate>1</graduate>
        <length>4</length>
        <length_unit>YEARS</length_unit>
        <specializations>
			<specialization>
		         <id>15</id>
		         <type>CONCENTRATION</type>
		         <name>American History</name>
		         <description>1900-2000</description>
		         <abbrv>AH</abbrv>
		         <status>ACTIVE</status>
		         <cip_code>10.0398</cip_code>
		    </specialization>
		</specializations>
    </degree>
</response>

Comments

You must have one of the following roles to call this task: Academic Admin, Registrar, Academic Auditor, Admissions, or Admissions Admin.

getEducationLevels

Returns all education levels (e.g. High School Diploma, Some College, etc).

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<education_level>
<id>1111</id>
<name>Less Than 9th Grade</name>
</education_level>
<education_level>
<id>2222</id>
<name>9th Grade to 12th Grade</name>
</education_level>
<education_level>
<id>3333</id>
<name>High School Diploma</name>
</education_level>
...
</response>

Comments

You must have the Admissions role to call this task.

Useful for looking up numeric IDs for passing into setLeadInfo.

getEntriesForAccount

Returns ledger transactions for a particular account.

Parameters

Parameter Description Required
account_id Numeric ID of the account. Yes
start_date The start date of the posted date filter (e.g. 2010-01-15). Yes
end_date The end date of the posted date filter (e.g. 2012-12-30). Yes
page We limit the number of results returned (see comments), so which "page" would you like (e.g. page=1, page=2, page=3). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response num_results="2528">
	<ledger_entry>
		<transaction_id>184381</transaction_id>
		<posted_date>2012-04-26</posted_date>
		<account_id>107</account_id>
		<debit>200.00</debit>
		<credit>0.00</credit>
		<actor_id>135497</actor_id>
		<actor_type>PERSON</actor_type>
		<actor_name>Bob, Joe</actor_name>
	</ledger_entry>
	...
</response>

Comments

You must have the Financial Admin role to call this task.

There is a limit of 1000 results in the response.

The "num_results" attribute (in the <response> element) indicates the total number of possible results (regardless of the limit or the page parameter).

getEvent

Returns data for a particular event.

Parameters

Parameter Description Required
eventID The numeric ID of the event you're interested in. Yes
recurrence If you want a particular occurrence of a reoccurring event. By default the first occurrence will be returned. Example: 2017-01-26. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <event>
        <eventid>1111</eventid>
        <ownertype>PERSON</ownertype>
        <ownerid>1234</ownerid>
        <calname>My Calendar</calname>
        <summary>Lunch</summary>
        <description></description>
        <allday>0</allday>
        <start>2017-01-26T13:00:00-06:00</start>
        <end>2017-01-26T14:00:00-06:00</end>
    </event>
</response>

Comments

Optional attendees, location, and resources data can be returned if present.

getEvents

Returns calendar events.

Parameters

Parameter Description Required
startDate Format like MM/DD/YYYY or YYYY-MM-DD. Defaults to today. No
endDate Format like MM/DD/YYYY or YYYY-MM-DD. Defaults to 1 month in the future. No
calendars An array of specific calendars to return events from. Defaults to returning events from the current user's calendars. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <event>
        <eventid>1111</eventid>
        <ownertype>PERSON</ownertype>
        <ownerid>1234</ownerid>
        <calname>My Calendar</calname>
        <summary>Lunch</summary>
        <description></description>
        <allday>0</allday>
        <recurrence>2017-01-26</recurrence>
        <color>
            <red>79</red>
            <green>140</green>
            <blue>255</blue>
        </color>
        <start>2017-01-26T13:00:00-06:00</start>
        <end>2017-01-26T14:00:00-06:00</end>
    </event>
    <event>
        <eventid>2222</eventid>
        <ownertype>INSTANCE</ownertype>
        <ownerid>5678</ownerid>
        <calname>ENG101: English 101</calname>
        <summary>Lecture</summary>
        <description></description>
        <allday>0</allday>
        <recurrence>2017-01-26</recurrence>
        <color>
            <red>107</red>
            <green>134</green>
            <blue>35</blue>
        </color>
        <start>2017-01-26T15:00:00-06:00</start>
        <end>2017-01-26T16:00:00-06:00</end>
    </event>
    ...
</response>

Comments

The "calendars" optional parameter example: array( array( 'ownertype' => 'PERSON', 'ownerid' => 1234 ), array( 'ownertype' => 'INSTANCE', 'ownerid' => 5678 ) )
array( 'ownertype' => 'PERSON', 'ownerid' => 1234 ) referes to a particular person and their ID
array( 'ownertype' => 'INSTANCE', 'ownerid' => 5678 ) referes to a particular course instance and it's ID

Possible 'ownertype' values include: 'PERSON', 'INSTANCE' (a course instance), 'ORG', 'ROOM', 'RESOURCE', 'CAMPUS', 'LIBRARY', 'LIBRARY_HOURS'

The "recurrence" attribute will only be present in the response if it's a recurring event

The "color" attribute is the particular calendar's color. So all of it's events and it's label will be presented in that color for distinguishing purposes

getFees

Returns all information related to fees configured for the institution.

Parameters

None

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <fee>
        <id>1093</id>
        <name>Full Time Tuition</name>
        <type>FLAT</type>
        <status>ACTIVE</status>
        <description>Tuition for Full Time Students</description>
        <amount>2000.00</amount>
        <max_amount>3000.00</max_amount>
        <report_on_1098t>1</report_on_1098t>
        <report_on_t2202a>0</report_on_t2202a>
        <refundable>1</refundable>
        <condition>OR</condition>
        <finaid_applies>1</finaid_applies>
        <fee_class>TUITION</fee_class>
        <account_name>Tuition</account_name>
        <account_number>X1</account_number>
        <account_type>INCOME</account_type>
    </fee>
    <fee>
        <id>1094</id>
        <name>Lab Fee</name>
        <type>FLAT</type>
        <status>ACTIVE</status>
        <description>Science lab fee</description>
        <amount>50.00</amount>
        <max_amount>50.00</max_amount>
        <report_on_1098t>0</report_on_1098t>
        <report_on_t2202a>0</report_on_t2202a>
        <refundable>0</refundable>
        <condition>AND</condition>
        <finaid_applies>0</finaid_applies>
        <fee_class>FEE</fee_class>
        <account_name>Special Fees</account_name>
        <account_number>X22</account_number>
        <account_type>INCOME</account_type>
    </fee>
</response>

Comments

You must have the Financial Admin, Student Billing, or Financial Aid role to call this task.

getFileDownloadURL

Returns a URL that can be used to download a file (valid for 10 minutes).

Parameters

Parameter Description Required
file_id The numeric ID of the file you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<url>
https://s3.amazonaws.com/files.populi.co/c000ad3cb61672bf32F10aec4d03Dd7f7.doc?AWSAccessKeyId=BKIAI0OM45DGDLXQFYDA&Expires=1308869410&Signature=IQdxEfIE4tYh6lxpimvKo8W16tM%3D
</url>
</response>

Comments

For security reasons, this link will only work for 10 minutes - if you need to get the actual contents of the file, see downloadFile.

getFinancialAidAwardTypes

Returns all available financial aid award types (both active and retired)

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <award_type>
        <id>1</id>
        <name>Pell Grant</name>
        <abbrv>PELL</abbrv>
        <type>GRANT</type>
        <status>ACTIVE</status>
        <source>FEDERAL</source>
        <need_based>1</need_based>
        <report_on_1098t>1</report_on_1098t>
        <count_against_need>1</count_against_need>
        <only_allow_whole_dollar_amounts>0</only_allow_whole_dollar_amounts>
        <liability_account>
            <id>147</id>
            <name>Pell Grant</name>
            <number>PELL</number>
        </liability_account>
    </award_type>
    <award_type>
        <id>2</id>
        <name>Supplemental Educational Opportunity Grant</name>
        <abbrv>FSEOG</abbrv>
        <type>GRANT</type>
        <status>ACTIVE</status>
        <source>FEDERAL</source>
        <need_based>1</need_based>
        <report_on_1098t>1</report_on_1098t>
        <count_against_need>1</count_against_need>
        <only_allow_whole_dollar_amounts>0</only_allow_whole_dollar_amounts>
        <liability_account>
            <id>195</id>
            <name>Supplemental Educational Opportunity Grant</name>
            <number>FSEOG</number>
        </liability_account>
    </award_type>
    ...
</response>

Comments

You must have the Financial Aid, Financial Admin or Student Billing role to call this task.

getFinancialAidAwards

Returns all aid awards for a particular aid year (see getFinancialAidYears).

Parameters

Parameter Description Required
aid_year_id The numeric ID of an aid year. Yes
award_type_id The numeric ID of an award type (see getFinancialAidAwardTypes). No
person_id The numeric ID of a student. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <award>
        <id>357</id>
        <student>
            <id>3093</id>
            <last_name>McMcintosh</last_name>
            <first_name>James</first_name>
            <student_id>2010000043</student_id>
        </student>
        <award_type>
            <id>1</id>
            <name>Pell Grant</name>
            <abbreviation>PELL</abbreviation>
            <type>GRANT</type>
            <source>FEDERAL</source>
        </award_type>
        <status>ACCEPTED</status>
        <scheduled_amount>0.00</scheduled_amount>
        <disbursed_amount>0.00</disbursed_amount>
        <net_amount>1000.00</net_amount>
        <amount>1000.00</amount>
    </award>
    <award>
        <id>359</id>
        <student><
            id>3093</id>
            <last_name>McMcintosh</last_name>
            <first_name>James</first_name>
            <student_id>2010000043</student_id>
        </student>
        <award_type>
            <id>2</id>
            <name>Supplemental Educational Opportunity Grant</name>
            <abbreviation>FSEOG</abbreviation>
            <type>GRANT</type>
            <source>FEDERAL</source>
        </award_type>
        <status>SETUP</status>
        <scheduled_amount>0.00</scheduled_amount>
        <disbursed_amount>0.00</disbursed_amount>
        <net_amount>1000.00</net_amount>
        <amount>1000.00</amount>
    </award>
    ...
</response>

Comments

You must have the Financial Aid, Financial Admin or Student Billing role to call this task.

getFinancialAidDisbursements

Returns all disbursements (whether original, to source, or to student) for a particular aid year (see getFinancialAidYears).

Parameters

Parameter Description Required
aid_year_id The numeric ID of an aid year Yes
type Possible values: DISBURSEMENT, REFUND_TO_SOURCE, REFUND_TO_STUDENT Yes
award_type_id The numeric ID of an award type (see getFinancialAidAwardTypes). No
academic_term_id The numeric ID of an academic term. No
person_id The numeric ID of a student. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <disbursement>
        <id>70</id>
        <award_id>357</award_id>
        <type>DISBURSEMENT</type>
        <amount>1000.00</amount>
        <scheduled_date>2009-05-26</scheduled_date>
        <status_date>2009-05-26</status_date>
        <posted_date/>
        <status>POSTED</status>
        <aid_application_id/>
        <aid_application_status/>
        <student>
            <id>111</id>
            <last_name>Smith</last_name>
            <first_name>Laura</first_name>
            <preferred_name/>
            <student_id>1998000006</student_id>
        </student>
        <award_type>
            <id>999</id>
            <name>Student Achievement Scholarship</name>
            <abbreviation>SASS</abbreviation>
        </award_type>
        <academic_term>
            <id>1111</id>
            <name>Fall 2010-2011</name>
        </academic_term>
    </disbursement>
    <disbursement>
        <id>471</id>
        <award_id>359</award_id>
        <type>DISBURSEMENT</type>
        <amount>1000.00</amount>
        <scheduled_date>2011-04-14</scheduled_date>
        <status_date>2011-04-14</status_date>
        <posted_date/>
        <status>SCHEDULED</status>
        <aid_application_id>20000</aid_application_id>
        <aid_application_status>COMPLETED</aid_application_status>
        <student>
            <id>99999</id>
            <last_name>O'Sentz</last_name>
            <first_name>Adam</first_name>
            <preferred_name/>
            <student_id>2007000060</student_id>
        </student>
        <award_type>
            <id>14</id>
            <name>Advanced Math Loan</name>
            <abbreviation>AABL</abbreviation>
        </award_type>
        <academic_term>
            <id>4444</id>
            <name>Spring 2010-2011</name>
        </academic_term>
    </disbursement>
    ...
</response>

Comments

You must have the Financial Aid, Financial Admin or Student Billing role to call this task.

getFinancialAidYears

Returns all financial aid years - note that these are different than calendar years, and each award must be attached to a financial aid year.

Parameters

None.

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <aid_year>
        <id>12</id>
        <name>2018-2019</name>
        <start_date>2018-07-01</start_date>
        <end_date>2019-06-30</end_date>
    </aid_year>
    <aid_year>
        <id>11</id>
        <name>2017-2018</name>
        <start_date>2017-07-01</start_date>
        <end_date>2018-06-30</end_date>
    </aid_year>
    ...    
</response>

Comments

You must have the Financial Aid, Financial Admin or Student Billing role to call this task.

getGradeReport

Returns the grade report for a particular student and term.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
term_id The numeric ID of the term you're interested in. Yes
program_id The numeric ID of the program you're interested in. Default to all programs (program_id 0). No
include_locked_grades Boolean. Defaults to true. No

Comments

You must have the Academic Admin or Registrar role to call this task.

This task will return raw binary data rather than XML. The Content-Type HTTP header will indicate MIME type, and the Content-Disposition header will contain the file name.

getInquiry

Returns a particular admissions inquiry.

Parameters

Parameter Description Required
inquiry_id The numeric ID of the inquiry. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <inquiry>
        <id>13</id>
        <person_id>9216473</person_id>
        <lead_id>46</lead_id>
        <first_name`>Sally</first_name`>
        <middle_name>T</middle_name>
        <last_name>Smith</last_name>
        <email>sally@university.edu</email>
        <phone>(123) 123-1234</phone>
        <address_id>40798</address_id>
        <subject>I am interested in your school.</subject>
        <content>I am interested in your school. Can you give me a call?</content>
        <program_id>26</program_id>
        <degree_id></degree_id>
        <specialization_id></specialization_id>
        <academic_term_id>190</academic_term_id>
        <counselor_id>2921</counselor_id>
        <auto_assigned_to></auto_assigned_to>
        <status>WAITING_ON_US</status>
        <lead_source_id>5</lead_source_id>
        <locale_id></locale_id>
        <added_on>Sep 25, 2014</added_on>
        <added_by>12574</added_by>
        <added_at>Sep 29, 2014 4:19pm</added_at>
        <deleted_by></deleted_by>
        <deleted_at></deleted_at>
    </inquiry>
</response>

Comments

You must have one of these roles to call this task: Admissions, Admissions Admin.

getInvoice

Returns all basic and associated information about an invoice. This could includes charges, payments, credits, financial aid payments, and deadlines.

Parameters

Parameter Description Required
invoice_id The numeric ID of the invoice. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <invoice>
        <id>895008</id>
        <type>INVOICE</type>
        <status>UNPAID</status>
        <invoice_number>643</invoice_number>
        <description>CS532-2</description>
        <person_id></person_id>
        <firstname>Grant</firstname>
        <lastname>Smith</lastname>
        <preferred_name></preferred_name>
        <middlename>Charles</middlename>
        <amount>9174.00</amount>
        <due_date>2016-08-01</due_date>
        <term_id>77</term_id>
        <term_name>Winter Term 2015-2016</term_name>
        <student_id>2000030001</student_id>
        <transaction_id>14253</transaction_id>
        <transaction_number>1165</transaction_number>
        <posted_date>2016-02-04</posted_date>
        <added_by>29212</added_by>
        <added_time>2016-02-04 11:43:18</added_time>
        <transaction_status>POSTED</transaction_status>
        <payment_plan_id>20</payment_plan_id>
        <payment_plan_applied_at>2016-07-02 15:31:26</payment_plan_applied_at>
        <payment_plan_name>Monthly Type 2</payment_plan_name>
        <total_fin_aid_charges>9174.00</total_fin_aid_charges>
        <id>0</id>
        <amount_paid>1397.78</amount_paid>
        <aid_paid>100.00</aid_paid>
        <amount_credited>222.00</amount_credited>
        <balance>7554.22</balance>
        <aid_expected>200.00</aid_expected>
        <charges>
            <charge>
                <item_type>TUITION</item_type>
                <invoice_item_id>28856</invoice_item_id>
                <description>CS532-2</description>
                <amount>8000.00</amount>
                <item_name>Undergrad 0.00-8.00</item_name>
                <finaid_applies>1</finaid_applies>
            </charge>
            <charge>
                <item_type>FEE</item_type>
                <invoice_item_id>60095</invoice_item_id>
                <description></description>
                <amount>1174.00</amount>
                <item_name>Lab Fee</item_name>
                <finaid_applies>1</finaid_applies>
            </charge>
        </charges>
        <payments>
            <payment>
                <payment_id>495</payment_id>
                <transaction_id>1399</transaction_id>
                <transaction_number>1059</transaction_number>
                <owner_type>PERSON</owner_type>
                <owner_id>13</owner_id>
                <payment_number>0</payment_number>
                <amount>100.00</amount>
                <applied_by>1257</applied_by>
                <posted_date>2016-02-02</posted_date>
                <payment_type>CUSTOMER_PAYMENT</payment_type>
                <applied_by_name>Mountain, Jonathan</applied_by_name>
                <applied_time>2016-02-12 15:28:03</applied_time>
                <is_finaid>0</is_finaid>
                <is_online>0</is_online>
            </payment>
        </payments>
        <credits>
            <credit>
                <amount>222.00</amount>
                <posted_date>2016-08-24</posted_date>
                <invoice_id>1504</invoice_id>
                <applied_to_invoice_id>895</applied_to_invoice_id>
                <applied_by>1257</applied_by>
                <applied_by_name>Mountain, Jonathan</applied_by_name>
                <applied_time>2016-08-24 14:33:52</applied_time>
            </credit>
        </credits>
        <expected_awards>
            <deadlines>
                <expected_award>
                    <invoice_scheduled_award_id>104</invoice_scheduled_award_id>
                    <pending_award_id>618</pending_award_id>
                    <added_by>1257</added_by>
                    <added_by_name>Mountain, Jonathan</added_by_name>
                    <added_time>2015-09-22 12:24:24</added_time>
                    <amount>200.00</amount>
                    <aid_name>Pell Grant</aid_name>
                    <term_name>Summer Term 2011-2012</term_name>
                    <added_at>2015-09-22 19:24:24</added_at>
                    <aid_abbrv>PELL</aid_abbrv>
                </expected_award>
            </expected_awards>
        </deadlines>
        <deadline>
            <deadline_id>646</deadline_id>
            <due_date>2016-08-01</due_date>
            <amount>500.00</amount>
            <max_balance>0.00</max_balance>
            <due_to_date>500.00</due_to_date>
            <prior_payments_credits>10.25</prior_payments_credits>
            <paid_to_date>178.00</paid_to_date>
            <still_due>0</still_due>
            <status>LATE</status>
            <late_fee_added>2016-09-02</late_fee_added>
        </deadline>
    </invoice>
</response>

Comments

You must have the Financial Admin or Student Billing role to call this task.

getLeadSources

Returns all the lead sources you've set up in the Admissions module.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<lead_source>
<id>1111</id>
<name>Admissions Poster at Conference</name>
<type>ADVERTISEMENT</type>
</lead_source>
<lead_source>
<id>2222</id>
<name>Datatel 2010 Lead List #1</name>
<type>PURCHASED</type>
</lead_source>
...
</response>

Comments

You must have the Admissions role to call this task.

Useful for looking up numeric IDs for passing into setLeadInfo.

getLedgerAccounts

Returns all ledger accounts.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<ledger_account>
		<id>107</id>
		<name>Tuition</name>
		<account_number>5180</account_number>
		<description>Aliquam et nisl vel ligula consectetuer suscipit...</description>
		<account_type>INCOME</account_type>
	</ledger_account>
	...
</response>

Comments

You must have the Financial Admin role to call this task.

getLessonContent

Returns the lessons attached to a course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance that contains the lesson. Yes
lesson_id The numeric ID of the lesson you're interested in. Yes

Example Response

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
<link rel="stylesheet" href="https://yourschool.populiweb.com/includes/css/inline_iframe.css" type="text/css" media="screen, projection" />
</head>
<body style="padding:18px; font-size:18px;">
<h3>Lesson Part 1</h3>
<p>
Proactively transform worldwide materials for transparent benefits. Dramatically evisculate
strategic solutions before leveraged mindshare. Competently monetize cost effective customer
service vis-a-vis robust convergence.
</p>

<img src="temporary_Amazon_S3_path_to_embedded_image_good_for_10_minutes.jpg"/>

<h3>Lesson Part 2</h3>
<p>
Competently productize customer directed synergy whereas market-driven opportunities.
Assertively underwhelm B2B schemas vis-a-vis high-payoff leadership. Proactively build
intuitive strategic theme areas and emerging methods of empowerment.
</p>
...
</body>
</html>

Comments

Note that this is a fully-formed HTML document, capable of being inserted into an iframe. If you'd prefer to style it differently you'll need to parse out the content of the <body> tag and insert it into your own HTML document.

getMealPlans

Returns all information related to meal plans configured for the institution.

Parameters

None

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <meal_plan>
        <id>9</id>
        <name>Standard</name>
        <amount>1444.00</amount>
        <status>ACTIVE</status>
        <account_name>Board</account_name>
        <account_number>5183</account_number>
    </meal_plan>
    <meal_plan>
        <id>3</id>
        <name>Deluxe</name>
        <amount>3100.00</amount>
        <status>ACTIVE</status>
        <account_name>Board</account_name>
        <account_number>5183</account_number>
    </meal_plan>
</response>

Comments

You must have the Financial Admin or Student Billing role to call this task.

getMyCourses

Returns all courses taken or taught for the current user for a particular term (or all terms currently in progress).

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in.  To call this task for anyone other than yourself, you must have the Registrar or Academic Admin role.  If not set, uses the person_id of the currently logged-in user. No
term_id The numeric ID of the term you're interested in.  If not specified, all terms currently in progress will be checked. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<my_course>
<instanceid>1111</instanceid>
<name>Intro to Classical &amp; Modern Geometry</name>
<abbrv>EDU321</abbrv>
<section>2</section>
<credits>2.00</credits>
<hours>14.00</hours>
<role>FACULTY</role>
</my_course>
<my_course>
<instanceid>2222</instanceid>
<name>Calculus discussion group</name>
<abbrv>CAL201</abbrv>
<section>1</section>
<credits>0.25</credits>
<hours>2.00</hours>
<role>STUDENT</role>
<enrollment_status>ENROLLED</enrollment_status>
<grade>97.00</grade>
<letter_grade>A+</letter_grade>
</my_course>
...
</response>

Comments

The <enrollment_status> element is only returned if the course is being taken by the user as a student - possible values are ENROLLED, AUDITOR, WITHDRAWN, or INCOMPLETE.

Two additional elemments (<grade> and <letter_grade>) are returned within each <my_course> element if all the following conditions are met:

  • <role>=STUDENT
  • <enrollment_status>=ENROLLED
  • the student has been assigned at least one grade in the course
  • the student is allowed to see his or her progress (the setting on the course instance must allow this, and there must be no locks applied on the student's profile)

getNews

Returns the Populi news feed, ordered most recent to least recent (with pinned articles at the top).

Parameters

Parameter Description Required
limit The maximim number of articles you'd like returned (defaults to 50). No
offset If a limit is specified, you can also specify an offset. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <article>
    <article_id>56</article_id>
    <title>Snow Day!</title>
    <content><
      ![CDATA[<p>HTML content (with <tags> and embedded media and stuff) goes here.</p>]]>
    </content>
    <pinned></pinned>
    <pinned_until>2011-04-30</pinned_until>
    <added_at>2011-04-29 14:44:31</added_at>
    <added_by>2920</added_by>
    <added_by_name>Bob McStaff</added_by_name>
    <updated_at></updated_at>
    <updated_by></updated_by>
    <updated_by_name></updated_by_name>
    <roles>
      <role>
        <id>5</id>
        <name>Student</name>
      </role>
      <role>
        <id>3</id>
        <name>Faculty</name>
      </role>
    </roles>
  </article>
  ...
</response>

Comments

The content element contains HTML, with embedded media links resolved absolutely (so no additional parsing should be necessary).

getPaymentPlans

Returns all financial payment plans.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<payment_plan>
		<id>4</id>
		<name>Undergraduate Plan</name>
		<fee_id>64</fee_id>
		<amount>100.00</amount>
		<amount_type>FLAT</amount_type>
		<late_fee>5.00</late_fee>
		<late_fee_type>PERCENT</late_fee_type>
		<min_invoice_amount>1000.00</min_invoice_amount>
		<exclude_scheduled_aid>0</exclude_scheduled_aid>
		<schedule_type>DAYS_FROM_INVOICE</schedule_type>
		<account_id>107</account_id>
		<account_number>5180</account_number>
		<account_name>Tuition</account_name>
		<break_out_by_charge_type>0</break_out_by_charge_type>
		<balance_month>0</balance_month>
		<balance_day>0</balance_day>
		<balance_num_days>90</balance_num_days>
	</payment_plan>
	...
</response>

Comments

You must have the Student Billing, Financial Admin, or Financial Aid role to call this task.

getPendingCharges

Returns all financial pending charges.

Parameters

Parameter Description Required
term_id Possible values: ALL (default), 0 (None), or any numeric term_id. No
campus_id Possible values: ALL (default), 0 (None), or any numeric campus_id. No
type Possible values: ALL (default), TUITION, FEE, ROOM_PLAN, MEAL_PLAN, or BOOKSTORE. No
page We limit the number of results returned (see comments), so which "page" would you like (e.g. page=1, page=2, page=3). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response num_results="215">
	<pending_charge>
		<id>9344</id>
		<person_id>3093</person_id>
		<student_id>2010000043</student_id>
		<first>James</first>
		<last>McMcintosh</last>
		<middle_name/>
		<preferred_name/>
		<term_id>204</term_id>
		<term_name>Spring 2010-2011</term_name>
		<charge_id>158</charge_id>
		<type>TUITION</type>
		<charge>Undergraduate Tuition 12.00-24.00 credits</charge>
		<description>Aliquam et nisl vel ligula consectetuer suscipit...</description>
		<amount>10000.00</amount>
	</pending_charge>
	...
</response>

Comments

You must have the Student Billing, Financial Admin, or Financial Aid role to call this task.

There is a limit of 1000 results in the response.

The "num_results" attribute (in the <response> element) indicates the total number of possible results (regardless of the limit or the page parameter).

getPerson

Returns basic profile data about a person: name, age, gender, tags, and contact information (address, phone, email).

Parameters

Parameter Description Required
person_id The numeric ID of the person. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<first>James</first>
	<last>McMcintosh</last>
	<middle_name>Rodrick</middle_name>
	<preferred_name>Jimmy</preferred_name>
	<prefix>Mr.</prefix>
	<suffix>III</suffix>
	<former_name/>
	<gender>MALE</gender>
	<birth_date>1990-01-01</birth_date>
	<citizenship>USA</citizenship>
	<resident_alien>0</resident_alien>
	<home_city>Moscow</home_city>
	<home_state>ID</home_state>
	<home_country>USA</home_country>
	<license_plate>Z 29765</license_plate>
	<image>_BASE_64_ENCODED_BINARY_IMAGE_DATA_RETURNED_HERE_</image>
	<address>
		<type>HOME</type>
		<addressid>1111</addressid>
		<street>P.O. Box 1994</street>
		<city>Moscow</city>
		<state>AR</state>
		<zip>88887</zip>
		<primary>1</primary>
	</address>
	<address>
		<type>WORK</type>
		<addressid>22222</addressid>
		<street>1000 1st Av</street>
		<city>Moscow</city>
		<state></state>
		<zip>123456</zip>
		<country>RU</country>
		<is_primary>0</is_primary>
	</address>
	<phone>
		<phoneid>44444</phoneid>
		<type>MOBILE</type>
		<number>111-222-3333</number>
		<is_primary>1</is_primary>
	</phone>
	<phone>
		<phoneid>55555</phoneid>
		<type>HOME</type>
		<number>222-222-2222</number>
		<is_primary>0</is_primary>
	</phone>
	<email>
		<emailid>66666</emailid>
		<type>WORK</type>
		<address>james@populi.co</address>
		<is_primary>1</is_primary>
	</email>
	<email>
		<emailid>7777</emailid>
		<type>HOME</type>
		<address>mypersonaladdress@gmail.com</address>
		<is_primary>0</is_primary>
	</email>
	<tags>
		<tag>
			<id>1</id>
			<name>Alumni</name>
			<system>1</system>
		</tag>
		<tag>
			<id>2</id>
			<name>Local Student</name>
			<system>0</system>
		</tag>
		...
	</tags>
</response>

Comments

If the person has a profile picture, the <image> element will contain base64 encoded binary data. The <image> element won't be returned unless the person has a profile picture set.

getPersonApplications

Returns all applications for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<application>
<id>1111</id>
<program_id>222</program_id>
<program_name>Undergraduate</program_name>
<degree_seeking>1</degree_seeking>
<degree_id>333</degree_id>
<degree_abbreviation>B.A.</degree_abbreviation>
<degree_name>Bachelor of Arts</degree_name>
<specialization_id>4444</specialization_id>
<specialization_abbreviation>ENG</specialization_abbreviation>
<specialization_name>English</specialization_name>
<full_time>1</full_time>
<term_id>6666</term_id>
<term_name>Fall Term 2008-2009</term_name>
<applied_date>2008-03-28</applied_date>
<submitted_date>2008-03-28</submitted_date>
<decision_date>2008-04-13</decision_date>
<withdrawn_date/>
<submitted_type>MANUAL</submitted_type>
<provisional>0</provisional>
<provisional_comment/>
<status>ACCEPTED</status>
</application>
<application>
<id>2222</id>
<program_id>223</program_id>
<program_name>Graduate</program_name>
<degree_seeking>1</degree_seeking>
<degree_id>334</degree_id>
<degree_abbreviation>M.A.</degree_abbreviation>
<degree_name>Master of Arts</degree_name>
<specialization_id>5555</specialization_id>
<specialization_abbreviation>HUM</specialization_abbreviation>
<specialization_name>Humanities</specialization_name>
<full_time>0</full_time>
<term_id>7777</term_id>
<term_name>Fall Term 2012-2013</term_name>
<applied_date>2012-03-02</applied_date>
<submitted_date>2012-03-02</submitted_date>
<decision_date>2012-03-15</decision_date>
<withdrawn_date/>
<submitted_type>ONLINE</submitted_type>
<provisional>0</provisional>
<provisional_comment/>
<status>COLLECTION</status>
</application>
...
</response>

Comments

You must have the Admissions role to call this task.

getPersonCommunicationPlans

Returns all active communication plans attached to a person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <communication_plan_instance>
        <id>98</id>
        <communication_plan_id>13</communication_plan_id>
        <communication_plan_name>Leads Communication Plan</communication_plan_name>
        <sender_id>3093</sender_id>
        <added_by>3093</added_by>
        <added_at>2017-02-09 23:45:27</added_at>
    </communication_plan_instance>
    ...
</response>

Comments

The current user must have the Staff role to call this task.

The <sender_id> element dictates who the email/letter will be sent from or who a to-do is assigned by.

getPersonLeads

Returns all leads attached to a person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <leads>
        <lead>
            <id>1</id>
            <first_name>James</first_name>
            <preferred_name>Jimmy</preferred_name>
            <middle_name>Rodrick</middle_name>
            <last_name>McMcintosh</last_name>
            <active>1</active>
            <most_recent>1</most_recent>
            <added_on>2016-07-27</added_on>
            <representative_id>2</representative_id>
            <representative_first_name>George</representative_first_name>
            <representative_preferred_name></representative_preferred_name>
            <representative_middle_name></representative_middle_name>
            <representative_last_name>Washington</representative_last_name>
            <status>ENROLLED</status>
            <program_id>1</program_id>
            <program_name>Undergraduate</program_name>
            <degree_id>1</degree_id>
            <degree_name>Bachelor of Arts</degree_name>
            <specialization_id>1</specialization_id>
            <specialization_name>Psychology</specialization_name>
            <academic_term_id>1</academic_term_id>
            <academic_term_name>2016-2017: Fall</academic_term_name>
            <source_id>1</source_id>
            <source_name>Advertisement (Billboard)</source_name>
            <source_comment>The billboard paid off</source_comment>
            <education_level_id>4</education_level_id>
            <education_level_name>Some College</education_level_name>
            <declined_reason_id>1</declined_reason_id>
            <declined_reason_name>Program/Curriculum</declined_reason_name>
            <declined_reason_comment></declined_reason_comment>
            <high_school_grad_date>2012-05-01</high_school_grad_date>
            <inquiries>
                <inquiry>
                    <id>1</id>
                </inquiry>
                ...
            </inquiries>
            <applications>
                <application>
                    <id>1</id>
                </application>
                ...
            </applications>
        </lead>
        ...
    </leads>
</response>

Comments

You must have the Admissions, Admissions Admin, Registrar, or Academic Admin role to call this task.

getPersonSSN

Gets the social security number for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>111-11-1111</result>
</response>

Comments

You must have SSN access permissions to call this task.

getPossibleDuplicatePeople

Called before you add a new person into Populi, this task returns similar people already in the system. You can then present the results to the user of your application and confirm they're not about to add a duplicate person.

Parameters

Parameter Description Required
first_name e.g. Bob Yes
last_name e.g. McProspect Yes
gender MALE or FEMALE No
birth_date e.g. 1979-10-02 No
email_address e.g. bob@gmail.com No
phone_number e.g. 777-888-9999 No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<possible_duplicate>
<id>99998</id>
<first_name>George</first_name>
<last_name>Washington</last_name>
<preferred_name>Jerry</preferred_name>
<birthdate>1732-02-22</birthdate>
<primary_email>george@gmail.com</primary_email>
<primary_phone>555-222-1111</primary_phone>
<primary_address>
<street>P.O. Box 1994</street>
<city>Moscow</city>
<state>ID</state>
<postal>88887</postal>
<country/>
</primary_address>
</possible_duplicate>
<possible_duplicate>
<id>99999</id>
<first_name>Larry</first_name>
<last_name>Washington</last_name>
<preferred_name/>
<birthdate/>
<primary_email>larry_w@gmail.com</primary_email>
<primary_phone/>
<primary_address>
<street>15555 Napa Valley Rd</street>
<city>Napa Valley</city>
<state>CA</state>
<postal>91210</postal>
<country>USA</country>
</primary_address>
</possible_duplicate>
...
</response>

Comments

You must have the Staff role to call this task.

You should always call this task before calling addPerson, and present the results to your end user to make sure they're not adding duplicate people.

Pass as much information as you can to this task - this will help us find better matches.

getPrograms

Returns information about each program configured at the school.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <program>
        <id>26</id>
        <name>Undergraduate</name>
        <units>CREDITS</units>
        <graduate_level>0</graduate_level>
        <status>ACTIVE</status>
        <default>1</default>
    </program>
    <program>
        <id>27</id>
        <name>Graduate</name>
        <units>CREDITS</units>
        <graduate_level>1</graduate_level>
        <status>ACTIVE</status>
        <default>0</default>
    </program>
    <program>
        <id>40</id>
        <name>Hourly Program</name>
        <units>HOURS</units>
        <graduate_level>0</graduate_level>
        <status>RETIRED</status>
        <default>0</default>
    </program>
</response>

Comments

You must have one of the following roles to call this task: Academic Admin, Registrar, Academic Auditor, Admissions, Admissions Admin.

getProvinces

Returns a list of provinces and their respective abbreviations.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<provinces>
		<province>
			<abbreviation>AB</abbreviation>
			<name>Alberta</name>
		</province>
		<province>
			<abbreviation>BC</abbreviation>
			<name>British Columbia</name>
		</province>
		...
	</provinces>
</response>

Comments

You must have the Staff role to call this task.

getRaces

Returns a list of race ids and their respective names.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<races>
		<race>
			<id>1</id>
			<name>American Indian or Alaska Native</name>
		</race>
		<race>
			<id>2</id>
			<name>Asian</name>
		</race>
		...
	</races>
</response>

Comments

You must have the Staff role to call this task.

getRoleMembers

Returns members of a particular role.

Parameters

Parameter Description Required
roleID Numeric ID of the role. No (but either roleID OR roleName MUST be set)
roleName Name of the role. No (but either roleID OR roleName MUST be set)
status Possible values: ACTIVE (default), INACTIVE, and ALL. No
page We limit the number of results returned (see comments), so which "page" would you like (e.g. page=1, page=2, page=3). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response num_results="10549">
	<person>
		<personID>3093</personID>
		<first>James</first>
		<last>McMcintosh</last>
		<inactive>0</inactive>
		<username>jamesm17</username>
	</person>
	...
</response>

Comments

You must have the Staff role to call this task.

There is a limit of 1000 results in the response.

The "num_results" attribute (in the <response> element) indicates the total number of possible results (regardless of the limit or the page parameter).

getRoles

Returns all active roles for a particular person (or the current users if no person_id is specified).

Parameters

Parameter Description Required
person_id The numeric ID of the person whose roles you wish to retrieve.  If not specified, the roles for the logged-in user will be returned. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<role>
<id>2</id>
<name>Admissions</name>
<inactive/>
</role>
<role>
<id>18</id>
<name>Bookstore</name>
<inactive/>
</role>
...
</response>

Comments

To get a list of all possible roles (not just those attached to this person), see getAvailableRoles

getRoomPlans

Returns all information related to room plans configured for the institution.

Parameters

None

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <room_plan>
        <id>58</id>
        <name>Apartment</name>
        <amount>3000.00</amount>
        <status>ACTIVE</status>
        <account_name>Room</account_name>
        <account_number>5182</account_number>
    </room_plan>
    <room_plan>
        <id>39</id>
        <name>Dorm</name>
        <amount>1400.00</amount>
        <status>DELETED</status>
        <account_name>Room</account_name>
        <account_number>5182</account_number>
    </room_plan>
</response>

Comments

You must have the Financial Admin or Student Billing role to call this task.

getStates

Returns a list of states and their respective abbreviations.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<states>
		<state>
			<abbreviation>AL</abbreviation>
			<name>Alabama</name>
		</state>
		<state>
			<abbreviation>AK</abbreviation>
			<name>Alaska</name>
		</state>
		...
	</states>
</response>

Comments

You must have the Staff role to call this task.

getStudentAssignmentSubmissions

Returns assignment submissions for a particular assignment and person.

Parameters

Parameter Description Required
assignment_id Numeric ID of the assignment. Yes
person_id Numeric ID of the person. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<files>
		<file>
			<submission_id>1520</submission_id>
			<file_id>18624</file_id>
			<name>Final Draft</name>
			<content_type>application/octet-stream</content_type>
			<added_by_id>168742</added_by_id>
			<added_by_name>Simon Student</added_by_name>
			<added_time>2013-08-02 14:11:25</added_time>
		</file>
		...
	</files>
	<comments>
		<comment>
			<submission_id>1525</submission_id>
			<content>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam urna lorem, tristique ut malesuada nec, posuere ut lectus.</content>	
			<added_by_id>17628</added_by_id>
			<added_by_name>Robert McProfessor</added_by_name>
			<added_time>2013-08-02 16:15:56</added_time>
		</comment>
		...
	</comments>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course Faculty member to call this task.

getStudentBalances

Returns all non-zero balances.

Parameters

Parameter Description Required
page We limit the number of results returned (see comments), so which "page" would you like (e.g. page=1, page=2, page=3). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response num_results="231">
	<student_balance>
		<id>111222</id>
		<balance>6086.62</balance>
		<first_name>Bob</first_name>
		<last_name>McStudent</last_name>
		<preferred_name/>
	</student_balance>
	<student_balance>
		<id>44444</id>
		<balance>5568.00</balance>
		<first_name>Fredrick</first_name>
		<last_name>Studentski</last_name>
		<preferred_name>Freddy</preferred_name>
	</student_balance>
	...
</response>

Comments

Student balances are not the same as "Pay Now" amounts, but rather the total amount of money the student owes. So Joe Student could owe the school $10,000 but due to payment plans and expected financial aid only have a "Pay Now" amount of $4,000. In this case, getStudentBalances would return his total balance - $10,000.

You must have the Student Billing or Financial Admin role to call this task.

There is a limit of 1000 results in the response.

The "num_results" attribute (in the <response> element) indicates the total number of possible results (regardless of the limit or the page parameter).

getStudentInfo

Returns student information for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in.  To call this task for anyone other than yourself, you must have the Registrar role, Academic Admin role, or be an advisor of the person.  If not set, uses the person_id of the currently logged-in user. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<student_id>2010000043</student_id>
	<first>James</first>
	<last>McMcintosh</last>
	<middle_name>Rodrick</middle_name>
	<preferred_name>Jimmy</preferred_name>
	<prefix>Mr.</prefix>
	<suffix>III</suffix>
	<gender>MALE</gender>
	<birth_date>1990-01-01</birth_date>
	<image>_BASE_64_ENCODED_BINARY_IMAGE_DATA_RETURNED_HERE_</image>
	<entrance_term_id>1</entrance_term_id>
	<entrance_term_name>Fall 1994-1995</entrance_term_name>
	<exit_date/>
	<exit_reason/>
	<advisors>
		<advisor>
			<person_id>1654987</person_id>
			<first>Chris</first>
			<last>Jones</last>
		</advisor>
		<advisor>
			<person_id>14684357</person_id>
			<first>Joe</first>
			<last>Bob</last>
		</advisor>
		...
	</advisors>
	<campuses>
		<campus>
			<campus_id>146873</campus_id>
			<name>Main Campus</name>
			<status>ACTIVE</status>
			<city>Moscow</city>
			<state>AZ</state>
			<zip>12345</zip>
			<country>USA</country>
			<is_primary>1</is_primary>
		</campus>
		...
	</campuses>
</response>

Comments

If the person has a profile picture, the element will contain base64 encoded binary data. The element won't be returned unless the person has a profile picture set.

An optional <advisors> element is returned for active students.

An optional <campuses> element is returned if the current user has the Staff role and your school has at least one campus set up.

getStudentPrograms

Returns the programs, degrees, and specializations for a particular student.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <programs>
        <program>
            <id>145987</id>
            <program_id>26</program_id>
            <name>Undergraduate</name>
            <started_on>2000-02-07</started_on>
            <inactive></inactive>
            <degrees>
                <degree>
                    <degree_id>1</degree_id>
                    <degree_student_id>10228</degree_student_id>
                    <abbrv>B.A.</abbrv>
                    <name>Bachelor of Arts</name>
                    <status>ACTIVE</status>
                    <active_date>2000-02-07</active_date>
                    <inactive_date></inactive_date>
                    <graduation_date></graduation_date>
                    <graduate_degree>0</graduate_degree>
                    <catalog_year_id>48</catalog_year_id>
                    <catalog_start_year>2000</catalog_start_year>
                    <catalog_end_year>2001</catalog_end_year>
                    <anticipated_completion_date>2004-02-07</anticipated_completion_date>
                    <specializations>
                        <specialization>
                            <specialization_id>513</specialization_id>
                            <name>English</name>
                            <type>MAJOR</type>
                            <status>ACTIVE</status>
                            <granted_date></granted_date>
                        </specialization>
                        ...
                    </specializations>
                </degree>
                ...
            </degrees>
        </program>
        ...
    </programs>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

getTaggedPeople

Returns people tagged with a particular tag.

Parameters

Parameter Description Required
tagID Numeric ID of the tag. No (but either tagId OR tagName MUST be set)
tagName Name of the tag. No (but either tagId OR tagName MUST be set)
page We limit the number of results returned (see comments), so which "page" would you like (e.g. page=1, page=2, page=3). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response num_results="2438">
	<person>
		<person_id>3093</person_id>
		<first_name>James</first_name>
		<last_name>McMcintosh</last_name>
	</person>
	<person>
		<person_id>54987</person_id>
		<first_name>Robert</first_name>
		<last_name>Jones</last_name>
	</person>
	...
</response>

Comments

You must have the Staff role to call this task.

There is a limit of 1000 results in the response.

The "num_results" attribute (in the <response> element) indicates the total number of possible results (regardless of the limit or the page parameter).

getTags

Returns a list of available tags.

Parameters

None.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<tags>
		<tag>
			<id>1</id>
			<name>Alumni</name>
			<system>1</system>
		</tag>
		<tag>
			<id>2</id>
			<name>Local Student</name>
			<system>0</system>
		</tag>
		...
	</tags>
</response>

Comments

You must have the Staff role to call this task.

getTermBillingInfo

Returns the students billing information for a particular academic term.

Parameters

Parameter Description Required
academic_term_id The numeric ID of the academic term you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <people>
        <person>
            <person_id>2222</person_id>
            <tuition_schedules>
                <tuition_schedule>
                    <tuition_schedule_id>2</tuition_schedule_id>
                    <tuition_schedule_name>Graduate</tuition_schedule_name>
                    <tuition_schedule_bracket_id>105</tuition_schedule_bracket_id>
                    <tuition_schedule_bracket_name>1.00-10.00 credits</tuition_schedule_bracket_name>
                </tuition_schedule>
                ...
            </tuition_schedules>
            <refund_policy_id>1</refund_policy_id>
            <refund_policy_name>Graduate</refund_policy_name>
            <meal_plan_id>9</meal_plan_id>
            <meal_plan_name>Standard</meal_plan_name>
            <room_plan_id>58</room_plan_id>
            <room_plan_name>Apartment</room_plan_name>
        </person>
        ...
    </people>
</response>

Comments

You must have the Student Billing or Financial Admin role to call this task.

getTermCourseInstances

Returns course instances for a given term (only active course instances are returned by default).

Parameters

Parameter Description Required
term_id The numeric ID of the term you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<course_instance>
<instanceid>11111</instanceid>
<courseid>123</courseid>
<name>History of Philosophy and Biblical Wisdom</name>
<abbrv>CUL301</abbrv>
<section>1</section>
<primary_faculty_id>4444</primary_faculty_id>
<primary_faculty_name>Jose Faculty</primary_faculty_name>
<description>This course teaches students about the many...</description>
<credits>2.00</credits>
<hours>0.00</hours>
<delivery_method_id>777</delivery_method_id>
<delivery_method_name>On Campus</delivery_method_name>
<campus_id>444</campus_id>
<campus_name>Portland</campus_name>
<start_date>2004-10-18</start_date>
<end_date>2004-12-18</end_date>
</course_instance>
<course_instance>
<instanceid>22222</instanceid>
<courseid>444</courseid>
<name>Calculus I</name>
<abbrv>MAT201</abbrv>
<section>3</section>
<primary_faculty_id>888</primary_faculty_id>
<primary_faculty_name>Sarah McFacuty</primary_faculty_name>
<description>This course teaches students about...</description>
<credits>0.00</credits>
<hours>10.00</hours>
<delivery_method_id>5555</delivery_method_id>
<delivery_method_name>Online</delivery_method_name>
<campus_id>6666</campus_id>
<campus_name>Main</campus_name>
<start_date>2004-10-18</start_date>
<end_date>2004-12-18</end_date>
</course_instance>
...
</response>

Comments

See getAcademicTerms if you'd like to get a list of all term_ids.

getTermEnrollment

Returns term enrollment for a particular academic term.

Parameters

Parameter Description Required
term_id Numeric ID of the academic term. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<enrollment>
		<person_id>1520</person_id>
		<academic_term_id>777</academic_term_id>
		<instance_id>44444</instance_id>
		<catalog_course_id>14678</catalog_course_id>
		<status>ENROLLED</status>
		<credits>3.00</credits>
		<hours>9.00</hours>
		<academic_term_name>Spring Term 2009-2010</academic_term_name>
		<course_abbrv>MAT201</course_abbrv>
		<course_name>Calculus I</course_name>
		<section>3</section>
	</enrollment>
	<enrollment>
		<person_id>1625</person_id>
		<academic_term_id>777</academic_term_id>
		<instance_id>44444</instance_id>
		<catalog_course_id>14678</catalog_course_id>
		<status>ENROLLED</status>
		<credits>3.00</credits>
		<hours>9.00</hours>
		<academic_term_name>Spring Term 2009-2010</academic_term_name>
		<course_abbrv>MAT201</course_abbrv>
		<course_name>Calculus I</course_name>
		<section>3</section>
	</enrollment>
	...
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

getTermStudents

Returns term students.

Parameters

Parameter Description Required
term_id Numeric ID of the term you're interested in. Defaults to the current academic term_id. No
program_id Possible values: ALL (default), NONE, or any numeric program_id. No
campus_id Possible values: ALL (default), 0 (None), or any numeric campus_id. No
page We limit the number of results returned (see comments), so which "page" would you like (e.g. page=1, page=2, page=3). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response num_results="265">
	<student>
		<person_id>3093</person_id>
		<student_id>2010000043</student_id>
		<first>James</first>
		<last>McMcintosh</last>
		<middle_name>Rodrick</middle_name>
		<preferred_name>Jimmy</preferred_name>
		<username>jimmyr</username>
		<prefix>Mr.</prefix>
		<suffix>III</suffix>
		<former_name>III</former_name>
		<gender>MALE</gender>
		<birth_date>1990-01-01</birth_date>
		<image>_BASE_64_ENCODED_BINARY_IMAGE_DATA_RETURNED_HERE_</image>
		<program_id>26</program_id>
		<program_name>Undergraduate</program_name>
		<standing>Senior</standing>
		<degree>B.A.</degree>
		<full_time>1</full_time>
		<units_attempted>12.00</units_attempted>
		<term_gpa>3.85</term_gpa>
		<cum_units_granted>100.00</cum_units_granted>
		<cum_gpa>3.55</cum_gpa>
		<cum_gpa_including_transfer>3.55</cum_gpa_including_transfer>
	</student>
	<student>
		<person_id>3093</person_id>
		<student_id>2010000043</student_id>
		<first>James</first>
		<last>McMcintosh</last>
		<middle_name>Rodrick</middle_name>
		<preferred_name>Jimmy</preferred_name>
		<username></username>
		<prefix>Mr.</prefix>
		<suffix>III</suffix>
		<former_name>III</former_name>
		<gender>MALE</gender>
		<birth_date>1990-01-01</birth_date>
		<image>_BASE_64_ENCODED_BINARY_IMAGE_DATA_RETURNED_HERE_</image>
		<program_id>27</program_id>
		<program_name>Graduate</program_name>
		<standing>Masters</standing>
		<degree>M.A.</degree>
		<full_time>0</full_time>
		<units_attempted>6.00</units_attempted>
		<term_gpa>3.25</term_gpa>
		<cum_units_granted>12.00</cum_units_granted>
		<cum_gpa>3.45</cum_gpa>
		<cum_gpa_including_transfer>3.45</cum_gpa_including_transfer>
	</student>
	...
</response>

Comments

You must have the Registrar or Academic Admin role to call this task.

If the person has a profile picture, the element will contain base64 encoded binary data. The element won't be returned unless the person has a profile picture set.

There is a limit of 1000 results in the response.

The "num_results" attribute (in the <response> element) indicates the total number of possible results (regardless of the limit or the page parameter).

getTodos

Returns todos for the current user.

Parameters

Parameter Description Required
completed Possible values: NO (default), YES, or BOTH. Whether you'd like to see completed todos, uncompleted todos, or all todos. No
limit The maximum number of todos you'd like returned. No
page If you're using a limit, which page of results would you like? So 2 for the second page, etc. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<todo>
<todoid>777</todoid>
<due_date>2009-07-02</due_date>
<overdue>1</overdue>
<assigned_to>11111</assigned_to>
<assigned_by>22222</assigned_by>
<attached_to>33333</attached_to>
<completed_time/>
<added_time>2009-06-25 17:57:21</added_time>
<content>Talk to Billy about his lack of academic progress</content>
<assigned_to_name>Robert McStaff</assigned_to_name>
<assigned_by_name>Reginald McPresident</assigned_by_name>
<attached_to_name>Billy Student</attached_to_name>
<attached_to_type>PERSON</attached_to_type>
</todo>
<todo>
<todoid>8888</todoid>
<due_date>2010-01-02</due_date>
<overdue>1</overdue>
<assigned_to>11111</assigned_to>
<assigned_by>11111</assigned_by>
<attached_to/>
<completed_time/>
<added_time>2010-01-02 17:57:21</added_time>
<content>Remember the milk on the way home...</content>
<assigned_to_name>Robert McStaff</assigned_to_name>
<assigned_by_name>Robert McStaff</assigned_by_name>
<attached_to_name/>
<attached_to_type>PERSON</attached_to_type>
</todo>
...
</response>

Comments

All times are returned in your school's local timezone.

Right now <attached_to_type> will always be PERSON - in future, you may be able to attach todos to organizations, etc.

getTransactions

Returns all financial transactions within a specified date range and the associated ledger entries.

Parameters

Parameter Description Required
start_date The start date used to filter the transactions. (e.g. 2016-01-01) Default is 30 days ago if not specified. No
end_date The end date used to filter the transactions. (e.g. 2016-12-31) Default is today if not specified. No
page We limit the number of results returned (see comments), so which "page" would you like (e.g. page=1, page=2, page=3). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response num_results="231">
	<transaction>
	    <id>6914</id>
	    <status>POSTED</status>
	    <type>SALES_CREDIT</type>
	    <payment_type>OTHER</payment_type>
	    <transaction_number>257623</transaction_number>
	    <primary_actor_type>PERSON</primary_actor_type>
	    <primary_actorid>21435</primary_actorid>
	    <student_id>SMITH_4488</student_id>
	    <primary_actor>Smith, Ben</primary_actor>
	    <amount>25.00</amount>
	    <posted_date>2/10/16</posted_date>
	    <invoiceid></invoiceid>
	    <invoice_number></invoice_number>
	    <paymentid></paymentid>
	    <reference_number></reference_number>
	    <payment_number></payment_number>
	    <payment_source_type></payment_source_type>
	    <donation_id></donation_id>
	    <donation_number></donation_number>
	    <added_by>12570</added_by>
	    <added_by_name>Frank Lenville</added_by_name>
	    <added_time>2/10/2016 16:09:41</added_time>
	    <voided_by></voided_by>
	    <voided_by_name></voided_by_name>
	    <voided_time></voided_time>
	    <ledger_entries>
	        <ledger_entry>
	            <account_name>Main Bank Account</account_name>
	            <account_number>6000</account_number>
	            <account_type>EXPENSE</account_type>
	            <debit>25.00</debit>
	            <credit>0.00</credit>
	            <actorid>2435</actorid>
	            <actor_type>PERSON</actor_type>
	            <actor_name>Smith, Ben</actor_name>
	        </ledger_entry>
	        <ledger_entry>
	            <account_name>Accounts receivable</account_name>
	            <account_number>1110</account_number>
	            <account_type>ASSET</account_type>
	            <debit>0.00</debit>
	            <credit>25.00</credit>
	            <actorid>2435</actorid>
	            <actor_type>PERSON</actor_type>
	            <actor_name>Smith, Ben</actor_name>
	        </ledger_entry>
	    </ledger_entries>
	</transaction>
</response>

Comments

Depending on the transaction type (invoice, payment, aid payment, credit, donation, etc.) different additional field values will be present in the results. Each transaction will include at least two ledger entries - one debit and one credit along with account details.

You must have the Financial Admin role to call this task.

There is a limit of 1000 results in the response.

The "num_results" attribute (in the <response> element) indicates the total number of possible results (regardless of the limit or the page parameter).

getTranscript

Returns the transcript for a particular student.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
pdf Boolean. If set to true, pdf content will be returned instead of xml. No
official (Requires the "pdf" parameter to be set to true) Boolean. If set to true, the official transcript pdf content will be returned. No
recipient (Requires the "pdf" parameter to be set to true) String. The recipient who will be receiving this transcript. No
include_course_desciptions (Requires the "pdf" parameter to be set to true) Boolean. If set to true, course descriptions will be returned in the pdf content. Note: course descriptions will always be returns in the xml. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<student>
	    <first_name>Joe</first_name>
	    <last_name>Bob</last_name>
	    <middle_name></middle_name>
	    <preferred_name></preferred_name>
	    <birth_date>Jan. 5 1985</birth_date>
	    <student_id>85494038</student_id>
	    <enrolled_date></enrolled_date>
	    <address>
	        <street>P.O. Box 1994</street>
	        <city>Moscow</city>
	        <state>AR</state>
	        <zip>88887</zip>
	    </address>
	</student>
	<honors>
	    <honor>
	        <honor_id>19748</honor_id>
	        <name>Cum Laude</name>
	    </honor>
	    ...
	</honors>
	<programs>
	    <program>
	        <honors>
	            <honor>
	                <honor_id>19748</honor_id>
	                <name>Cum Laude</name>
	            </honor>
	            ...
	        </honors>
	        <degrees>
	            <degree>
	                <degree_id>1</degree_id>
	                <degree_student_id>10228</degree_student_id>
	                <abbrv>B.A.</abbrv>
	                <name>Bachelor of Arts</name>
	                <status>ACTIVE</status>
	                <active_date>2000-02-07</active_date>
	                <inactive_date></inactive_date>
	                <graduation_date></graduation_date>
	                <graduate_degree>0</graduate_degree>
	                <catalog_year_id>48</catalog_year_id>
	                <catalog_start_year>2010</catalog_start_year>
	                <catalog_end_year>2011</catalog_end_year>
	                <honors>
	                    <honor>
	                        <honor_id>19748</honor_id>
	                        <name>Cum Laude</name>
	                    </honor>
	                    ...
	                </honors>
	                <clinical_hour_course_groups>
	                    <clinical_hour_course_group>
	                        <course_group_id>846</course_group_id>
	                        <name>English</name>
	                        <clinical_hours>0</clinical_hours>
	                        <required_clinical_hours>10.00</required_clinical_hours>
	                    </clinical_hour_course_group>
	                    ...
	                </clinical_hour_course_groups>
	                <attendance_hour_course_groups>
	                    <attendance_hour_course_group>
	                        <course_group_id>846</course_group_id>
	                        <name>English</name>
	                        <attendance_hours>0</attendance_hours>
	                        <required_attendance_hours>10.00</required_attendance_hours>
	                    </attendance_hour_course_group>
	                    ...
	                </attendance_hour_course_groups>
	                <specializations>
	                    <specialization>
	                        <specialization_id>513</specialization_id>
	                        <name>English</name>
	                        <type>MAJOR</type>
	                        <status>ACTIVE</status>
	                        <granted_date></granted_date>
	                        <clinical_hour_course_groups>
			                    <clinical_hour_course_group>
			                        <course_group_id>846</course_group_id>
			                        <name>English</name>
			                        <clinical_hours>0</clinical_hours>
			                        <required_clinical_hours>10.00</required_clinical_hours>
			                    </clinical_hour_course_group>
			                    ...
			                </clinical_hour_course_groups>
			                <attendance_hour_course_groups>
			                    <attendance_hour_course_group>
			                        <course_group_id>846</course_group_id>
			                        <name>English</name>
			                        <attendance_hours>0</attendance_hours>
			                        <required_attendance_hours>10.00</required_attendance_hours>
			                    </attendance_hour_course_group>
			                    ...
			                </attendance_hour_course_groups>
	                    </specialization>
	                    ...
	                </specializations>
	            </degree>
	            ...
	        </degrees>
	        <transfer_credits>
	            <institution>
	                <courses>
	                    <course>
	                        <abbrv>ENG101</abbrv>
	                        <name>English 101</name>
	                        <attempted_units>3.00</attempted_units>
	                        <earned_units>3.00</earned_units>
	                        <earned_standing_units>3.00</earned_standing_units>
	                        <quality_points>4.00</quality_points>
	                        <grade_abbrv>A</grade_abbrv>
	                        <letter_grade>A</letter_grade>
	                        <attendance_hours>20.50</attendance_hours>
	                        <clinical_hours>18.25</clinical_hours>
	                    </course>
	                    ...
	                </courses>
	                <totals>
	                    <gpa>4.00</gpa>
	                    <quality_points>48.00</quality_points>
	                    <gpa_units>12.00</gpa_units>
	                    <attempted_units>12.00</attempted_units>
	                    <earned_units>12.00</earned_units>
	                    <earned_standing_units>12.00</earned_standing_units>
	                    <attendance_hours>42.50</attendance_hours>
	                    <clinical_hours>30.25</clinical_hours>
	                </totals>
	            </institution>
	            ...
	        </transfer_credits>
	        <term_courses>
	            <term>
	            	<term_id>1354</term_id>
	            	<name>Spring Term 2012-2013</name>
	            	<start_date>2013-01-15</start_date>
	            	<end_date>2013-04-15</end_date>
	                <honors>
	                    <honor>
	                        <honor_id>19748</honor_id>
	                        <name>Cum Laude</name>
	                    </honor>
	                    ...
	                </honors>
	                <discipline>
	                    <name>Academic Suspension</name>
	                    ...
	                </discipline>
	                <courses>
	                    <course>
	                        <instance_id>84632</instance_id>
	                        <course_id>98435</course_id>
	                        <abbrv>ENG102</abbrv>
	                        <name>English 102</name>
	                        <start_date>2013-01-15</start_date>
	            			<end_date>2013-04-15</end_date>
	                        <attempted_units>3.00</attempted_units>
	                        <earned_units>3.00</earned_units>
	                        <attempted_contra-units>3.00</attempted_contra-units>
	                        <earned_contra-units>3.00</earned_contra-units>
	                        <earned_standing_units>3.00</earned_standing_units>
	                        <status>ENROLLED</status>
	                        <grade_abbrv>A</grade_abbrv>
	                        <letter_grade>A</letter_grade>
	                        <numeric_grade>100.00</numeric_grade>
	                        <quality_points>12.00</quality_points>
	                        <gpa_units>3.00</gpa_units>
	                        <course_evaluation_grades_locked>0</course_evaluation_grades_locked>
	                        <teacher_person_id>468721</teacher_person_id>
	                        <teacher_first_name>Bob</teacher_first_name>
	                        <teacher_last_name>Teacher</teacher_last_name>
	                        <teacher_preferred_name></teacher_preferred_name>
	                        <attempted_attendance_hours>20.50</attempted_attendance_hours>
	                        <earned_attendance_hours>20.50</earned_attendance_hours>
	                        <attempted_clinical_hours>18.25</attempted_clinical_hours>
	                        <earned_clinical_hours>18.25</earned_clinical_hours>
	                    </course>
	                    ...
	                </courses>
	                <totals>
	                    <gpa>4.00</gpa>
	                    <gpa_including_transfer>4.00</gpa_including_transfer>
	                    <quality_points>48.00</quality_points>
	                    <gpa_units>12.00</gpa_units>
	                    <attempted_units>12.00</attempted_units>
	                    <attempted_contra-units>12.00</attempted_contra-units>
	                    <earned_units>12.00</earned_units>
	                    <earned_contra-units>12.00</earned_contra-units>
	                    <earned_standing_units>12.00</earned_standing_units>
	                    <cumulative_gpa>4.00</cumulative_gpa>
	                    <cumulative_gpa_including_transfer>4.00</cumulative_gpa_including_transfer>
	                    <cum_quality_points>48.00</cum_quality_points>
	                    <cum_gpa_units>48.00</cum_gpa_units>
	                    <cum_attempted_units>12.00</cum_attempted_units>
	                    <cum_attempted_contra-units>12.00</cum_attempted_contra-units>
	                    <cum_earned_units>12.00</cum_earned_units>
	                    <cum_earned_contra-units>12.00</cum_earned_contra-units>
	                    <attempted_attendance_hours>20.50</attempted_attendance_hours>
	                    <earned_attendance_hours>20.50</earned_attendance_hours>
	                    <cum_attempted_attendance_hours>55.50</cum_attempted_attendance_hours>
	                    <cum_earned_attendance_hours>55.50</cum_earned_attendance_hours>
	                    <attempted_clinical_hours>18.25</attempted_clinical_hours>
	                    <earned_clinical_hours>18.25</earned_clinical_hours>
	                    <cum_attempted_clinical_hours>53.25</cum_attempted_clinical_hours>
	                    <cum_earned_clinical_hours>53.25</cum_earned_clinical_hours>
	                </totals>
	            </term>
	        </term_courses>
	        <totals>
	            <attempted_units>24.00</attempted_units>
	            <attempted_contra-units>24.00</attempted_contra-units>
	            <earned_units>24.00</earned_units>
	            <earned_contra-units>24.00</earned_contra-units>
	            <earned_standing_units>24.00</earned_standing_units>
	            <transfer_attempted_units>12.00</transfer_attempted_units>
	            <transfer_attempted_contra-units>12.00</transfer_attempted_contra-units>
	            <transfer_earned_units>12.00</transfer_earned_units>
	            <transfer_earned_contra-units>12.00</transfer_earned_contra-units>
	            <transfer_earned_standing_units>12.00</transfer_earned_standing_units>
	            <cumulative_gpa>4.00</cumulative_gpa>
	            <quality_points>192.00</quality_points>
	            <gpa_units>48.00</gpa_units>
	            <transfer_gpa>4.00</transfer_gpa>
	            <transfer_quality_points>16.00</transfer_quality_points>
	            <transfer_gpa_units>12.00</transfer_gpa_units>
	            <attempted_attendance_hours>90.75</attempted_attendance_hours>
	            <earned_attendance_hours>90.75</earned_attendance_hours>
	            <transfer_attendance_hours>38.00</transfer_attendance_hours>
	            <attempted_clinical_hours>95.00</attempted_clinical_hours>
	            <earned_clinical_hours>95.00</earned_clinical_hours>
	            <transfer_clinical_hours>28.20</transfer_clinical_hours>
	        </totals>
	    </program>
	    ...
	</programs>
	<course_descriptions>
	    <course_description>
	        <instance_id>84632</instance_id>
	        <name>English 102</name>
	        <description>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</description>
	    </course_description>
	    ...
	</course_descriptions>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

If pdf = true, this will return raw binary data rather than XML. The Content-Type HTTP header will indicate MIME type, and the Content-Disposition header will contain the file name.

"Contra-units" - If your program uses credits the contra-units would be hours, and vice versa.

getTuitionSchedules

Returns all information related to tuition schedules and brackets configured for the institution.

Parameters

None

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="ISO-8859-1"?>
<response>
    <tuition_schedule>
        <id>107</id>
        <name>Auditor</name>
        <detail>1.00-12.00 credits: $350.00, 0.00 per unit</detail>
        <tuition_schedule_brackets>
            <tuition_schedule_bracket>
                <id>22</id>
                <units>CREDITS</units>
                <min_units>1.00</min_units>
                <max_units>12.00</max_units>
                <flat_amount>350.00</flat_amount>
                <per_unit_amount>0.00</per_unit_amount>
                <per_unit_threshold>0.00</per_unit_threshold>
                <in_use>2</in_use>
                <account_id>107</account_id>
                <account_name>Tuition</account_name>
                <account_number>5180</account_number>
            </tuition_schedule_bracket>
        </tuition_schedule_brackets>
    </tuition_schedule>
    <tuition_schedule>
        <id>2</id>
        <name>Graduate</name>
        <detail>1.00-10.00 credits: $0.00, 300.00 per unit&lt;br/&gt; 11.00-15.00 credits: $3500.00, 0.00 per unit</detail>
        <tuition_schedule_brackets>
            <tuition_schedule_bracket>
                <id>105</id>
                <units>CREDITS</units>
                <min_units>1.00</min_units>
                <max_units>10.00</max_units>
                <flat_amount>0.00</flat_amount>
                <per_unit_amount>300.00</per_unit_amount>
                <per_unit_threshold>0.00</per_unit_threshold>
                <in_use>1</in_use>
                <account_id>107</account_id>
                <account_name>Tuition</account_name>
                <account_number>5180</account_number>
            </tuition_schedule_bracket>
            <tuition_schedule_bracket>
                <id>16</id>
                <units>CREDITS</units>
                <min_units>11.00</min_units>
                <max_units>15.00</max_units>
                <flat_amount>3500.00</flat_amount>
                <per_unit_amount>0.00</per_unit_amount>
                <per_unit_threshold>0.00</per_unit_threshold>
                <in_use>0</in_use>
                <account_id>107</account_id>
                <account_name>Tuition</account_name>
                <account_number>5180</account_number>
            </tuition_schedule_bracket>
        </tuition_schedule_brackets>
    </tuition_schedule>
</response>

Comments

You must have the Financial Admin or Student Billing role to call this task.

getUpdatedEnrollment

Returns updated enrollment for a particular time.

Parameters

Parameter Description Required
start_date Format should be a date like "2010-11-06". Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<enrollment>
		<person_id>1520</person_id>
		<term_id>777</term_id>
		<instance_id>44444</instance_id>
		<catalog_course_id>14678</catalog_course_id>
		<status>ENROLLED</status>
		<status_date>2011-02-18</status_date>
		<credits>3.00</credits>
		<hours>9.00</hours>
		<academic_term_name>Spring Term 2009-2010</academic_term_name>
		<course_abbrv>MAT201</course_abbrv>
		<course_name>Calculus I</course_name>
		<section>3</section>
	</enrollment>
	<enrollment>
		<person_id>1625</person_id>
		<term_id>777</term_id>
		<instance_id>44444</instance_id>
		<catalog_course_id>14678</catalog_course_id>
		<status>ENROLLED</status>
		<status_date>2010-11-22</status_date>
		<credits>3.00</credits>
		<hours>9.00</hours>
		<academic_term_name>Spring Term 2009-2010</academic_term_name>
		<course_abbrv>MAT201</course_abbrv>
		<course_name>Calculus I</course_name>
		<section>3</section>
	</enrollment>
	...
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

getUpdatedPeople

Returns all people who have had information changed since start_time. This is useful if you want to sync Populi users to a directory service, etc.

Parameters

Parameter Description Required
start_time Return all people with updated info since this second. Format should be a local timestamp like "2010-11-06 13:27:10". Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<person>
<id>4444444</id>
<first_name>Doug</first_name>
<last_name>McFaculty</last_name>
<preferred_name/>
<middle_name/>
<prefix>Mr.</prefix>
<suffix/>
<former_name/>
<maiden_name/>
<gender>MALE</gender>
<birth_date>1979-10-02</birth_date>
<status>ACTIVE</status>
<is_active_user>1</is_active_user>
<user_name>dougf</user_name>
<updated_at>2011-05-09 13:42:00</updated_at>
</person>
<person>
<id>88888</id>
<first_name>James</first_name>
<last_name>McProspect</last_name>
<preferred_name>Jim</preferred_name>
<middle_name/>
<prefix/>
<suffix>III</suffix>
<former_name/>
<maiden_name/>
<gender>MALE</gender>
<birth_date>1988-06-04</birth_date>
<status>ACTIVE</status>
<is_active_user>0</is_active_user>
<user_name/>
<updated_at>2011-04-09 13:42:00</updated_at>
</person>a
...
</response>

Comments

People count as updated if their roles, tags, profile data, password, or contact information change. People added/deleted since start_time will also be returned.

Status can be ACTIVE, DELETED, or DECEASED.

The idea here is to make it possible to periodically run a script which pulls changes out of Populi since the last time it ran and pushes them to another system (e.g. Open Directory or Active Directory). If you want to sync contact info, check out getPerson to pull more detailed information.

invoicePendingCharges

Creates an invoice based from pending charges associate with a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
academic_term_id The academic term ID that the pending charges are attached to. This is optional because some pending charges may not be attached to an academic term. No
due_date The date that the invoice is due. Defaults to your specified due date setting (if set), otherwise the defaults to the academic term start date (if an academic_term_id is passed in and the academic term's start date is in the future), otherwise the default is 30 days in the future. No
posted_date The transaction's posted date. Defaults to the current date. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <invoice_id>2222</invoice_id>
</response>

Comments

You must have the Student Billing or Financial Admin role to call this task.

postFinancialAidDisbursement

Posts an existing scheduled disbursement.

Parameters

Parameter Description Required
disbursement_id The numeric ID of a disbursement with a status of SCHEDULED (but not SETUP, POSTED, DELETED or VOID) Yes
posted_date Format should be a date like "2010-11-06". Defaults to the current date. No
notify_student Boolean. Send a notification email to the student's primary email address. Defaults to true. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Financial Aid role to call this task.

removeAdvisorFromStudent

Removes an advisor from a student.

Parameters

Parameter Description Required
advisor_id The numeric ID of the advisor you're interested in. Yes
student_id The numeric ID of the student you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

removeRole

Removes a role from a person.

Parameters

Parameter Description Required
person_id Numeric ID of the person you're interested in. Yes
role_id The numeric ID of the role you want to remove. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>SUCCESS</response>

Comments

Unfortunately, at this time the Student role cannot be added/removed through the API.

The current user must have the Staff role and permission to add the role (this varies by role... so Academic Admins can remove the Registrar role, Admissions Admins can remove the Admission role, etc).

See getAvailableRoles to look up all possible roles and their numeric IDs.

removeTag

Removes a tag from a particular person.

Parameters

Parameter Description Required
person_id Numeric ID of the person whose tag should be removed. Yes
tag_id Numeric ID of the tag. No (but either tag_id or tag must be set)
tag The actual tag you want to be removed (e.g. "Do not call", or "Good reference"). No (but either tag_id or tag must be set)

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>SUCCESS</response>

Comments

You must have the Staff role to call this task.

The tag_id or tag that you pass in must exist in Populi or a BAD_PARAMETER error will be thrown. However, this task will return SUCCESS even if the particular person doesn't have the particular tag - Populi will do nothing in that case.

System tags cannot be removed by anyone other than Populi... so certain tags like "Expelled" are off-limits. To remove these tags, you'll need to take some action in Populi - the correct system tags will be removed as a byproduct of that action.

requestBackup

Requests a backup of your Populi data, delivered as a ZIP file in CSV format. You can be notified by email when it's ready for download, or have an HTTP request made to another web application.

Parameters

Parameter Description Required
on_complete_email Where to send the "Backup Ready for Download" email. No
on_complete_url If set, when the backup is ready for download we'll make an HTTP request to this URL, including the backup_id as a POST variable. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<id>11111</id>
</response>

Comments

The <id> returned is the ID of the backup request (the same ID that will be passed to on_complete_url).

See downloadBackup to download the backup after it's completed.

searchPeople

Looks up people by name, email, phone number, etc.

Parameters

Parameter Description Required
search_term e.g. "Joe McStudent" or "208-111-2222" or "joe@mcstudent.edu" Yes
limit The maximum number of matches you'd like returned - defaults to 10. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<person>
<id>11111</id>
<first_name>Robert</first_name>
<last_name>McStudent</last_name>
<middle_name>Kensington</middle_name>
<preferred_name>Bobby</preferred_name>
<is_user>1</is_user>
<primary_email>r.mcstudent@myschool.edu</primary_email>
</person>
<person>
<id>2222</id>
<first_name>Robert</first_name>
<last_name>McBoardmember</last_name>
<middle_name/>
<preferred_name/>
<is_user>0</is_user>
<primary_email>robert@gmail.com</primary_email>
</person>
...
</response>

Comments

Metaphone matching is used to try to correct misspellings... so you can accidentally search for "Mervin Smith" and hopefully get Marvin Smith returned.

Use getPerson to look up more detailed information about one of your search results.

setApplicationField

Sets a value for a particular application field.

Parameters

Parameter Description Required
application_field_id Numeric ID of the application field you're interested in. Yes
value (or multiple "value[]" parameters for MULTIPLE_ANSWER) The value for this field. No (but depends on the field - see comments)
reference_email The email address that should receive an online reference invitation. No (but depends on the field - see comments)
reference_message A personal message to the recipient of the online reference invitation. No
street The street portion of an address. No (but depends on the field - see comments)
city The city portion of an address. No (but depends on the field - see comments)
state A state or province abbreviation. No (but depends on the field - see comments)
zip The zip/postal code portion of an address. No (but depends on the field - see comments)
country A country abbreviation. No (but depends on the field - see comments)
hispanic_latino Boolean. No (but depends on the field - see comments)
race_ids[] Numeric ID of a race (can pass multiple race_ids[]). No (but depends on the field - see comments)
date_taken The date a standardized test was taken. No (but depends on the field - see comments)
total_score The total score for a statndardized test. No (but depends on the field - see comments)

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Admissions role or be the owner of the application to call this task.

The value must be a valid option for the field or a BAD_PARAMETER error will be returned.

Most fields require value (or multiple value[] parameters for MULTIPLE_ANSWER.) except those listed below:
ONLINE_REFERENCE fields require reference_email - reference_message is optional.
STATE_PROVINCE fields require country and state
RACE_ETHNICITY fields require hispanic_latino and race_ids[] (can pass multiple race_ids[]).
ADDRESS fields require street, city, state, zip and country.
STANDARDIZED_TEST fields require date_taken and total_score.

setCustomField

Sets a custom field value for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
custom_field_id The numeric ID of the custom field you're interested in. Yes
term_id The numeric ID of the term you're interested in. No (but must be set for TERM_STUDENT type fields)
value (or multiple "value[]" parameters for CHECKBOXes) The value for this field. No (but either value or option_index must be set - see comments)
option_index (or multiple "option_index[]" parameters for CHECKBOXes) For RADIOs and SELECTs, you can pass in the index of the selected option. No (but either value or option_index must be set - see comments)

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Staff role to call this task.

For fields RADIOs and SELECTs, you can pass in either the selected option value itself (e.g. "McNeil Dorm"), or the index of that option (e.g. 7). Either way, it must be a valid option for that custom field or a BAD_PARAMETER error will be returned.

For CHECKBOXes, you can pass multiple values by changing the value parameter to value[] and repeating it.

For FILE input type fields, pass in a numeric file_id.

setLeadInfo

Sets information about an admissions lead.

Parameters

Parameter Description Required
person_id Numeric ID of the person whose lead information you'd like to change. Yes
status PROSPECT, INQUIRY, APPLICATION_STARTED, APPLICATION_COMPLETED, ACCEPTED, CONFIRMED, ENROLLED No
term_id The numeric ID of the term the school hopes the lead will attend. No
source_id The numeric ID of the source this lead to which this lead should be attributed. No
source_comment A short comment describing this lead's source (i.e. "Where did this lead come from?"). No
ed_level_id The numeric education level ID associated with this lead (e.g. High School, Some College, etc). No
admissions_officer_id The numeric person ID of the main admissions officer responsible for this lead (he or she should have the Admissions role). No
high_school_grad_date The date this lead graduated from High School (e.g. 2010-06-15) No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>SUCCESS</response>

Comments

Pass in only the fields you want to change - the ones you don't pass in will be left alone with their current value intact.

This task can be called on any person.

You must have the Admissions role to call this task.

See getAcademicTerms, getLeadSources, getEducationLevels to look up the various numeric IDs you can pass into this function.

setPersonBirthDate

Sets the birth date for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
birth_date e.g. 1979-10-02 Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Staff role to call this task.

setPersonCitizenship

Sets the citizenship for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
citizenship The citizenship country abbreviation for the person. Yes
resident_alien Boolean. e.g. 1 or 0. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

See the getCountries task for a list of valid country abbreviations.

You must have the Staff role to call this task.

setPersonGender

Sets the gender for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
gender MALE, FEMALE, or UNKNOWN Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Staff role to call this task.

setPersonHometown

Sets the hometown for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
city The hometown city for the person. No
state The hometown state abbreviation for the person. No
country The hometown country abbreviation for the person. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The "state" parameter can also take a province.

See the getStates task for a list of valid state abbreviations.

See the getProvinces task for a list of valid province abbreviations.

See the getCountries task for a list of valid country abbreviations.

You must have the Staff role to call this task.

setPersonName

Sets the name a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
prefix   No
first_name   No
preferred_name   No
middle_name   No
last_name   No
suffix   No
former_name   No
maiden_name   No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You do not have to pass in all the individual name pieces. For example, if you only want to update the person's preferred name and middle name then simply pass in preferred_name and middle_name.

You must have the Staff role to call this task.

setPersonRaceEthnicity

Sets the race/ethnicity for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
hispanic_or_latino Boolean. Yes
race_ids[] Numeric ID of a race (can pass multiple race_ids[]). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

See the getRaces task for a list of valid race IDs.

If passing in multiple race_ids[] parameters you may need to index the options (e.g. race_ids[0] => 1, race_ids[1] => 2)

You must have the Staff role to call this task.

setPersonSSN

Sets the social security number for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
ssn The social security number for the person. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have SSN editing permissions to call this task.

setStudentAssignmentGrade

Sets an assignment grade for a particular student.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes
assignment_id The numeric ID of the assignment you're interested in. Yes
person_id The numeric ID of the person you're interested in. Yes
grade The assignment grade for the student. Yes
recalculate_final_grade Boolean. If set to true, the final grade will be recalculated. Defaults to false. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

setStudentEntranceTerm

Sets the entrance term for a particular student.

Parameters

Parameter Description Required
person_id The numeric ID of the person you're interested in. Yes
term_id The numeric ID of the term you're interested in. Yes
student_program_id The numeric ID of the student's program you're interested in. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

If `student_program_id` is not passed in we will set the entrance term on all of the student's active programs.

For `student_program_id` see the `id` element in the getStudentPrograms API task.

setStudentFinalGrade

Sets the final grade for a particular student in a particular course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes
person_id The numeric ID of the person you're interested in. Yes
grade The final grade for the student. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin or Registrar role to call this task.

setStudentID

Sets a student's ID

Parameters

Parameter Description Required
person_id Numeric ID of the person whose student ID you'd like to change. Yes
student_id The new student ID Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role or the Registrar role to call this task.

setTodoCompleted

Marks a todo completed or not completed.

Parameters

Parameter Description Required
todo_id The numeric ID of the todo you're interested in. Yes
completed Possible values: 1 (default) or 0. Whether the todo should be marked completed. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

This function can only be used on todos assigned to the currently logged-in user.

submitApplication

Submits an application.

Parameters

Parameter Description Required
application_id Numeric ID of the application you're interested in. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Admissions role or be the owner of the application to call this task.

updateAddress

Updates an address.

Parameters

Parameter Description Required
addressid Numeric ID of the address. Yes
street e.g. 777 Magnolia Ln No
city e.g. Moscow No
state e.g. ID No
postal e.g. 83843 No
country e.g. USA No
type Person addresses: HOME, WORK, BILLING, SHIPPING, OTHER
Organization addresses: MAIN, BILLING, SHIPPING, OTHER
No
primary Boolean. Use if you want to mark the address as primary or not primary. e.g. 1 or 0 No
old Boolean. Use if you want to mark the address as old or not old. e.g. 1 or 0 No
public Boolean. Use if you want to mark the address as public or not public. e.g. 1 or 0 No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role or else be updating an address on his/her own profile.

updateCourseInstanceAssignment

Updates an assignment in a particular course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes
assignment_id The numeric ID of the assignment you're interested in. Yes
name The name of the assignment. No
type GRADE_ONLY, FILE_UPLOAD, PEER_REVIEW_FILE_UPLOAD, TEST, ATTENDANCE, DISCUSSION, ESSAY, or PEER_REVIEW_ESSAY No
discussion_id Only used when the assignment type is DISCUSSION. The numeric ID of the discussion you want to use (the default is 0 which means a new discussion will be created). No
description A description of the assignment. No
catalog_course_ids Only used if the course is cross-listed. This would be an array of catalog course IDs that the assignment applies to. If you leave this parameter out of the request the assignment will apply to all cross-listed courses. No
points The number of points that the assignment is worth. No
extra_credit Boolean. e.g. 1 or 0. No
group_id The assignment group ID this assignment belongs to (group_id 0 is the built-in "Other" group). No
time_due When the assignment is due (e.g. 2017-06-30 23:59:59 - must be in the course instance's timezone). No
visible_to_students_before_due When the passed in type is TEST this sets whether or not the test is visible before it's available. No
     
  The following parameters are only used when the assignment type is TEST:  
availability FROM, AFTER, BEFORE, or ALWAYS. If the value is FROM and both start_window and end_window are empty then the test will not be available. No
start_window When the test availability starts. Only used when the availability parameter is FROM or AFTER. No
end_window When the test availability ends. Only used when the availability parameter is FROM or BEFORE. No
time_limit The time limit in minutes (time_limit 0 means "No time limit"). No
retake_policy NO_RETAKES (no retakes), KEEP_HIGHEST (keep highest score), KEEP_LAST (keep most recent score), AVERAGE (average all scores). No
retakes The number of retakes allowed (only used when the retake_policy is not NO_RETAKES). No
answers_visible NOT_VISIBLE (not visible), AFTER_TAKING (visible after test completion), AFTER_WINDOW (visible after test end date). No
proctored Boolean. e.g. 1 or 0. No
     
  The following parameters are only used when the assignment type is PEER_REVIEW_FILE_UPLOAD or PEER_REVIEW_ESSAY:  
peer_grade Boolean. e.g. 1 or 0. No
grade_submission_points The number of points that submissions are worth. No
grade_review_points The number of points that reviews are worth. No
anonymous_reviews Boolean. e.g. 1 or 0. No
review_visibility NEVER (not visible to other students), AFTER_REVIEW (visible to other students after their review), ALWAYS (visible to other students). No
allow_review_comments Boolean. e.g. 1 or 0. Only used when review_visibility is not NEVER. No
reviews_time_due When reviews are due (e.g. 2017-06-30 23:59:59 - must be in the course instance's timezone). No
reviews_closed_date_time When reviews are closed (e.g. 2017-06-30 23:59:59 - must be in the course instance's timezone). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task.

Only assignments with the GRADE_ONLY type may be switched to the DISCUSSION type.

updateCourseInstanceAssignmentGroup

Updates an assignment group in a particular course instance.

Parameters

Parameter Description Required
instance_id The numeric ID of the course instance you're interested in. Yes
group_id The numeric ID of the assignment group you're interested in. Yes
name The name of the assignment group. No
weight The assignment group's weight percent (the default is 0). No
extra_credit Boolean. e.g. 1 or 0 (the default is 0). No
drop_lowest The number of lowest-graded assignments to drop from this group for each student (the default is 0). No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task.

updateCourseOfferingLink

Updates a link attached to a particular course offering.

Parameters

Parameter Description Required
course_offering_id The numeric ID of the course offering you're interested in. Yes
link_id The numeric ID of the link you're interested in. Yes
name The name of the link. No
url The URL for the link. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <result>SUCCESS</result>
</response>

Comments

You must have the Academic Admin role, the Registrar role, or be a course teacher to call this task (and the course must not be finalized).

updateEmailAddress

Updates an email address.

Parameters

Parameter Description Required
emailid Numeric ID of the email address. Yes
email_address e.g. bob@example.com No
type Person email addresses: HOME, WORK, OTHER
Organization email addresses: WORK, OTHER
No
primary Boolean. Use if you want to mark the email address as primary or not primary. e.g. 1 or 0 No
old Boolean. Use if you want to mark the email address as old or not old. e.g. 1 or 0 No
public Boolean. Use if you want to mark the email address as public or not public. e.g. 1 or 0 No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role or else be updating an email address on his/her own profile.

updateLicensePlate

Updates a person's license plate.

Parameters

Parameter Description Required
person_id The numeric ID of the person. Yes
license_plate The person's license plate. Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role to call updateLicensePlate.

updatePhoneNumber

Updates a phone number.

Parameters

Parameter Description Required
phoneid Numeric ID of the phone number. Yes
phone_number e.g. 1-800-888-8888 No
type Person phone numbers: HOME, WORK, MOBILE, FAX, OTHER
Organization phone numbers: WORK, FAX, OTHER
No
primary Boolean. Use if you want to mark the phone number as primary or not primary. e.g. 1 or 0 No
old Boolean. Use if you want to mark the phone number as old or not old. e.g. 1 or 0 No
public Boolean. Use if you want to mark the phone number as public or not public. e.g. 1 or 0 No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>SUCCESS</result>
</response>

Comments

The current user must have the Staff role or else be updating a phone number on his/her own profile.

updateStudentAttendance

Update a student's attendance.

Parameters

Parameter Description Required
instanceID The numeric ID of the course instance you're interested in. Yes
meetingID The numeric ID of the meeting. Yes
personID Numeric ID of the person whose attendance will be updated. Yes
status PRESENT, ABSENT, TARDY, EXCUSED Yes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Status updated</message>
</response>

uploadFile

Uploads a file for a particular person.

Parameters

Parameter Description Required
person_id The numeric ID of the person. Yes
file File uploaded the via the HTTP POST method. Yes
custom_field_id If passed in, the file will be uploaded to the given custom info field. No
term_id The numeric ID of the term you're interested in. No (but must be set for TERM_STUDENT custom fields)
role_ids[] The file will be visible to people with these role IDs. No

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>12345678</result>
</response>

Comments

You must have the Staff role to call this task.

Returns the file_id on success.

The role_ids[] parameter will not be used for custom info fields.

You can pass in multiple role_ids[] parameters.

If no role_ids[] are passed in we will default to the user's "Default activity feed visibility" setting.

If you pass in custom_field_id you will not need to call setCustomField, we will set the field for you.

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

0 Comments

Article is closed for comments.