Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Clarified coach_school_id handling.

...

ParameterExternal TableLocationField NameDescriptionExample
photo_urlexternal_personMain-Dashboard
Main-Details
Main-Coach
<photo>Student's photograph 
first_nameexternal_person

Main-Dashboard
Main-Details
Main-Schedule

NameStudent's first nameRobert
middle_nameexternal_personMain-Dashboard
Main-Details
Main-Schedule
NameStudent's middle nameBradley
last_nameexternal_person

Main-Dashboard
Main-Details
Main-Schedule

NameStudent's last nameJones
school_idexternal_personMain-Dashboard
Main-Details
Student IDStudent's id or other identifier used by the institution to identify students, faculty, or other staff.rjones330
birth_dateexternal_personMain-Dashboard
Main-Details
Main-Contact
DOBStudent's birthdate10/24/86
home_phoneexternal_personMain-Dashboard
Main-Details
Main-Contact
PhoneStudent's home phone number(555) 555-1212
primary_email_addressexternal_personMain-Dashboard
Main-Details
Main-Contact
Main-Coach
EmailStudent's primary email addressdemo@testdrivessp.com
student_type_codeexternal_personMain-Dashboard
Main-Details
EAL Details
Student TypeThe value displayed on-screen is the name of the reference item, which is not necessarily the same as itscode (e.g. "First Time in College" vs "FTIC"). The external data should contain the code, not the actual value.First Time in College
<SSP Status>person_program_statusMain-Dashboard
Main-Details
SSP StatusInternal to SSP (not populated from external database table); this field is set implicitly when first adding a student to SSP or explicitly by several buttons in the coach's caseload view.Active
genderexternal_personMain-DetailsGenderStudent's genderM
marital_statusexternal_personMain-DetailsMarital StatusStudent's marital status. Note that unlike student_type_code, the value in marital_status is expected to be a screen-displayable name.Separated
ethnicityexternal_personMain-DetailsEthnicityStudent's ethnicity. Note that unlike student_type_code, the value in ethnicity is expected to be a screen-displayable name.Other
race_codeexternal_personMain-DetailsRaceStudent's race. Like student_type_code, the value displayed on-screen is the name of the reference item, which is not necessarily the same as its code (e.g. "White" vs "W"). The external data should contain the code, not the actual value. 
grade_point_averageexternal_student_transcriptMain-Dashboard
Main-Details
MAP-FinancialAid
GPAThe calculated cumulative GPA value1.82
financial_aid_gpaexternal_student_financial_aidMain-Details
MAP-FinancialAid
FA GPAThe GPA calculated for financial aid eligibility1.82
academic_standingexternal_student_transcriptMain-Dashboard
Main-Details
StandingCurrent academic standing of the studentProbation
current_restrictionsexternal_student_transcriptMain-Dashboard
Main-Details
MAP-FinancialAid
RestrictionsList of any restrictions or holds on the student recordie. Dismissed, Hold, Fine
credit_hours_earnedexternal_student_transcriptMain-Details
MAP-FinancialAid
Hrs EarnedThe total value of credit hours successfully completed or earned31
credit_hours_attemptedexternal_student_transcriptMain-Details
MAP-FinancialAid

Hrs AttemptedThe total value of credit hours attempted whether or not included in the hours for GPA or hours earned36
credit_completion_rateexternal_student_transcriptMain-Dashboard
Main-Details
MAP-FinancialAid
Comp RateCompletion rate of hours attempted86%
credit_typeexternal_student_transcript_course

Main-Details
Main-Transcript
MAP-Transcript

Transfer Hrs

The number of transfer hours the student has completed.
Including or excluding this value from the Hrs Earned Value is optional.

ie. Institutional, Transfer, Proficiency, Placement
term_codeexternal_registration_status_by_termMain-Dashboard
Main-Details
MAP-FinancialAid
RegList of current and future terms for which the student is registeredFA2013
tuition_paidexternal_registration_status_by_termMain-Dashboard
Main-Details
MAP-FinancialAid
PaymentY or N, indicates payment status of tuition for the termFA2013=N
balance_owedexternal_personMain-Details
MAP-FinancialAid
BalanceStudent's balance currently owed to the college. Format is XXXXX.XX.$0.00
FAFSA_dateexternal_student_financial_aidMain-Details
MAP-FinancialAid
FAFSAThe date the FAFSA was accepted08/24/2013
current_year_financial_aid_awardexternal_student_financial_aidMain-Dashboard
Main-Details
MAP-FinancialAid
FA AwardY or N, indicates if the student received financial aid for the current academic yearY
remaining_loan_amount external_student_financial_aidMain-Details
MAP-FinancialAid
FA AmountThe remaining amount of loans available to the student$809.00
original_loan amount external_student_financial_aidMain-Details
MAP-FinancialAid
Loan AmountThe original amount of loans available to the student$6,600.00
sap_status external_student_financial_aidMain-Dashboard
Main-Details
MAP-FinancialAid
SAPY or N, indicates if the student has achieved Satisfactory Academic ProgressN
F1_statusexternal_personMain-Dashboard
Main-Details
MAP-FinancialAid
F1Y or N, indicates if the student has an F1 Visa on fileY
program_nameexternal_student_academic_programMain-Dashboard
Main-Details
Academic ProgramFormatted program name used for display in SSPAssociates of Science in Automotive Technology
statusexternal_person_planning_statusMain-Dashboard
Main-Details
MAP-Main Page
MAPThe status of the active plan. Valid values are On and Off.Off Plan
coach_school_idexternal_personMain-Details
Main-Coach
EAL Details
AdvisorCoach (first & last name) assigned to student. The value displayed on-screen is the coach actually assigned to the student when the screen is rendered, which may or may not be the same as the coach referenced by coach_school_id. Handling of that field is controlled by options set on the Admin -> Administrative Tools -> System Configuration -> Configuration Options screen. See coachSetFromExternalData and coachUnsetFromExternalDataDemo Coach23
<Last Updated>map_plan

Main-Dashboard
Main-Details

Last UpdatedThis date is the last time the MAP was saved or changed. This field is populated from an internal SSP database field.05/20/2012
<MAP Projected Grad>map_planMain-Dashboard
Main-Details
MAP Projected GradThis value is derived from the last term on the current MAP that contains courses. This is assumed to be the graduating term. This field is populated from an internal SSP database field.WN2015
intended_program_at_admitexternal_student_academic_programMain-DetailsIntended Program at AdmitFrom the Admissions application, the intended program of student formatted program name used for display in SSP.Associates of Science in Automotive Technology

...