SAP Function BAPI_STUDENTACADRESULTS_GET - Read Student Performance Indexes

Parameter Reference Type Length Default Optional Text
ACAD_SESSION PIQPROG_GR_PERID N 3 X Academic Session
ACAD_YEAR PIQPROG_GR_PERYR N 4 X Progression: Academic Year
CHECK_FROM BAPISTUDENTPROGGR_HEAD-CHECK_FROM D 8 Check-From Date for Progression
CHECK_TO BAPISTUDENTPROGGR_HEAD-CHECK_TO D 8 Check-To Date for Progression
LANGUAGE BAPI_LAISO-LANGU C 1 X Language Key
LANGUAGE_ISO BAPI_LAISO-LANGU_ISO C 2 X Language According to ISO 639
OBJECTID BAPISTUDENT_HEAD-OBJID N 8 Student Object ID
PLANVERSION BAPISTUDENT_HEAD-PLVAR C 2 X Plan Version
PROGRAM_TYPE BAPISTUDENTPROGGR_HEAD-PROGRAM_TYPE C 4 Program Type
PROGRESSION_CATEGORY BAPISTUDENTPROGGR_HEAD-PROGRESSION_TYPE C 1 Progression Category
READ_TEXTS BAPISTUDENT_READTEXTS C 1 X Indicator: Also Read Texts

Parameter Reference Length Optional Text
PERFORMANCE_INDICES BAPIPERFORMANCE_INDEX 42 X Performance Indexes
PERFORMANCE_INDICEST BAPIPERFORMANCE_INDEXT 162 X Performance Indexes and Descriptions
RETURN BAPIRET2 548 X Return Parameters

Functionality
This method reads the performance indexes of students for a given checkperiod. The check period is independent of the current progressionresult.

Notes

Performance
This method selectively reads only those database tables in which thisparameter is queried at the interface or contains a value. It reads theinternal SAP keys as well as the relevant texts. With the parameterLANGUAGE, you can define the language in which the texts are read. Thetexts and keys are transferred in structures whose names end with theletter 'T'.

Authorizations
Users must have a structural authorization for students as well as theauthorization to display the program type progression activity (PG04).

Reading Data for an Object Instance in a Logical Unit of Work (LUW)
When a write method (CREATE or CHANGE) and read method (GETDETAIL) arecalled for an object instance within alogical unit of work (LUW)
, the read method (GETDETAIL) cannot properly determine the studentdata because it has no buffer. Moreover, the data is not entirelystored on the database. For more information on this topic, read thedocumentation of the methodBAPI_STUDENT_CREATEFROMDATA3.

Further information
Methods that can be called together with this method:
If you only know the student number, you can determine the internal key(object ID) of the student number with the methodBAPI_ADDRESS_STUDENT_GET_NUMB.

Description
The parameter CHECK_FROM contains the check-from date. This date istransferred to performance index calculation and can be used there torestrict the module bookings.

Description
The parameter CHECK_TO contains the check-to date. This date is used todetermine the relevant module bookings. A module booking is relevant ifthe valid-from date is before or identical to the check-to datespecified in module booking usage.

Description
In the parameter LANGUAGE, you specify the language key.
The language key defines the language in which the method reads thetexts.
If no value is specified, the method reads the texts in the logonlanguage.

Description
This parameter specifies the ISO language code of the language in whichthe method is to read the texts.

Default
The default setting is the system language.

Description
INCLUDE BAPI_KEYFIELD

Description
INCLUDE BAPI_KEYFIELD

Description
The parameter PROGRESSION_CATEGORY contains the progression categoryfor which the method is to determine performance indexes.

Value range
1 = Academic honors
2 = Academic standing
3 = Academic standing for financial aid
4 = Progress classification
5 = Progress classification for financial aid

Description
INCLUDE PIQBAPI_READTEXTS

Value range

  • 'X' = Read texts

  • ' ' = Do not read texts

    • Description
    The system transfers the performance indexes and the relevant textfields in the table PERFORMANCE_INDICEST.
    INCLUDE BAPI_DATAELEMENT

    Description
    INCLUDE BAPI_TABLE
    INCLUDE BAPI_DATAELEMENT