# Get academic summary Provides a summary of academic and educational data, including dates of attendance, degrees achieved, and other fields. Please see response payload for the detailed fields. MeasureOne uses a set of heuristics to make a final determination. These heuristics are summarized in Reason Codes as detailed in the following table. ### Reason Codes |Code|Description| |--- |--- | |MAS_DRVD_ATTNDNC_ACAD_SESSION|Attendance determined via academic session enrollments| |MAS_DRVD_STD_CLSF_CRSE_IN_PRG|Courses are in progress| | MAS_EXPLICIT_TYPE | Enrollment Type explicitly available on the school website | | MAS_DRVD_ENRL_TYPE_ENRL_STS | Enrollment Type derived based INACTIVE enrollment status | | MAS_DRVD_ENRL_TYPE | Enrollment Type derived based on credits attempted in currently enrolled term | | MAS_DRVD_ENRL_TYPE_PRV_TERM | Enrollment Type derived based on credits attempted in the previous enrolled term within 180 days of the date available in the data | | MAS_DRVD_ENRL_TYPE_INFR_CRED | Enrollment Type derived based on inferred credits attempted | | MAS_DRVD_ENRL_TYPE_COOP_CRSE | Enrollment Type derived based on enrolled COOP course | |MAS_INSUFFICIENT_DATA|Attendance record not available| |MAS_INSUFFICIENT_DATA|Date degree was awarded not available| |MAS_INSUFFICIENT_DATA|Degree GPA not available| |MAS_INSUFFICIENT_DATA|Degree majors not available| |MAS_INSUFFICIENT_DATA|Description of degree not available| |MAS_INSUFFICIENT_DATA|Number of credits not available| |MAS_INSUFFICIENT_DATA|Number of degree credits not available| |MAS_INSUFFICIENT_DATA|Status of student degree not available| |MAS_INSUFFICIENT_DATA|Student classification data not available| |MAS_INSUFFICIENT_DATA|Student degree data not available| |MAS_INSUFFICIENT_DATA|Student GPA not available| |MAS_INSUFFICIENT_DATA|Type of student degree not available| |MAS_INSUFFICIENT_DATA|Enrollment Type of student not available| |ITEM_ON_HOLD|Student transcript(s) on financial hold| |MAS_VF_DAC|Verification method: Direct school account connection| |MAS_VF_USD|Verification method: User-submitted transcript| |MAS_VF_DAC_USD|Verification method: Direct school account connection and one or more user-submitted transcript| Endpoint: POST /v3/services/get_academic_summary Version: 3.0 Security: Bearer ## Header parameters: - `version` (number) Version number of the MeasureOne API you wish to integrate. - `Authorization` (string) Authorization API Key - `Content-type` (string) Content-type of the request payload. MeasureOne accepts content in application/json format unless specified otherwise ## Response 200 fields (application/json): - `individual` (object) - `individual.individual_id` (string) Unique ID of the Individual identified by MeasureOne - `individual.datasources` (array) - `datarequest_id` (string) Unique ID of the Data Request identified by MeasureOne - `service_context_id` (string) Unique ID of the service context identified by MeasureOne - `processing_status` (string) Processing status of the request. - MeasureOne has finished processing of the request. - We have received the request and system is acquiring the academic summary. Note that if MeasureOne system requires any intervention from our team, the status will update to IN_PROGRESS. - We have received the request and our team is working to process the the academic summary. Enum: "COMPLETED", "ACQUIRING", "IN_PROGRESS" - `metadata` (object) metadata can be used for storing additional information in a structured format. metadata will be sent in webhooks and report response. - `academic_summary` (array) - `academic_summary.datasource` (object) Datasource details - `academic_summary.datasource.id` (string) MeasureOne datasource identifier - `academic_summary.datasource.type` (string) Type of datasource - `academic_summary.datasource.name` (string) Name of datasource - `academic_summary.datasource.address` (object) Address of datasource - `academic_summary.datasource.address.addr1` (string) - `academic_summary.datasource.address.addr2` (string) - `academic_summary.datasource.address.city` (string) - `academic_summary.datasource.address.state` (string) - `academic_summary.datasource.address.zipcode` (string) - `academic_summary.datasource.address.country` (object) - `academic_summary.datasource.address.country.name` (string) - `academic_summary.student` (object) - `academic_summary.student.first_name` (string) First name of the Individual - `academic_summary.student.middle_name` (string) Middle name of the Individual - `academic_summary.student.last_name` (string) Last Name of the Individual - `academic_summary.student.prefix` (string) Name prefix - `academic_summary.student.suffix` (string) Name suffix - `academic_summary.student.full_name` (string) Full name of the Individual - `academic_summary.student.former_first_name` (string) Former first name of the Individual - `academic_summary.student.former_middle_name` (string) Former middle name of the Individual - `academic_summary.student.former_last_name` (string) Former last Name of the Individual - `academic_summary.student.former_prefix` (string) Former name prefix - `academic_summary.student.former_suffix` (string) Former name suffix - `academic_summary.student.former_full_name` (string) Former full name of the Individual - `academic_summary.student.date_of_birth` (string) Date of Birth of the Individual in MM/DD/YYYY format. - `academic_summary.student.ssn` (string) Social Security Number of the Individual - `academic_summary.student.email` (string) Email address of the Individual - `academic_summary.student.address` (object) - `academic_summary.student.phone_number` (string) Phone number of the Individual - `academic_summary.degrees` (array) List of degrees - `academic_summary.degrees.type` (string) Level of the degree. Enum , , , , , , , , , , - `academic_summary.degrees.description` (string) Name of the degree - `academic_summary.degrees.status` (string) Status of the degree. Enum , , , , - `academic_summary.degrees.awarded_date` (string) Degree awarded date (applicable to graduates only) - `academic_summary.degrees.years_of_study` (number) Number of years of study for the given degree - `academic_summary.degrees.majors` (array) List of enrolled majors for the given degree - `academic_summary.degrees.concentrations` (array) List of enrolled concentrations for the given degree - `academic_summary.degrees.minors` (array) List of enrolled minors for the given degree - `academic_summary.degrees.gpa_range` (object) GPA range for School/University - `academic_summary.degrees.gpa_range.minimum` (number) value scale for GPA - `academic_summary.degrees.gpa_range.maximum` (number) value scale for GPA - `academic_summary.degrees.gpa` (number) GPA earned in the degree - `academic_summary.degrees.credits` (number) Credits earned in the degree - `academic_summary.attendance` (array) - `academic_summary.attendance.start_date` (string) - `academic_summary.attendance.end_date` (string) - `academic_summary.gpa` (number) GPA earned - `academic_summary.teaching_institution` (object) Object with information about the teaching institution for which the transcript was issued - `academic_summary.teaching_institution.name` (string) Name of the institution - `academic_summary.teaching_institution.id` (string) Unique identifier of the institute - `academic_summary.teaching_institution.id_type` (string) Type of ID used to identify given institution Enum , - `academic_summary.teaching_institution.address` (object) Student's Address information as provided for previous academic record - `academic_summary.teaching_institution.address.addr1` (string) Address line 1 - `academic_summary.teaching_institution.address.addr2` (string) Address line 2. Should be populated only if is populated - `academic_summary.teaching_institution.address.city` (string) City - `academic_summary.teaching_institution.address.state` (string) State - `academic_summary.teaching_institution.address.zipcode` (string) Zipcode for the address - `academic_summary.degree_awarding_institution` (object) Object with information about the degree awarding institution for which the transcript was issued - `academic_summary.credits` (number) Credits earned - `academic_summary.enrollment_status` (string) Enrollment Status of the Individual as presented in the academic profile Enum: "ACTIVE", "INACTIVE", "UNKNOWN" - `academic_summary.student_classification` (object) Student level of the Individual - `academic_summary.student_classification.code` (string) Code identifying the student level. Enum , , , - `academic_summary.reason_codes` (array) Array of reason codes used for determining the academic summary. Helps developer understand how has the academic summary been derived. - `academic_summary.reason_codes.code` (string) Reason code applicable - `academic_summary.reason_codes.description` (string) Description providing details to understand how has the academic summary been derived. - `academic_summary.reason_codes.context` (object) Context to understand where the reason code is applicable - `academic_summary.reason_codes.context.attribute` (string) Details of JSON path attribute for which reason code is applicable - `academic_summary.reason_codes.context.source_data_type` (string) source data type for which reason code is applicable - `academic_summary.as_of_date` (number) timestamp in milliseconds - `academic_summary.enrollment_type` (string) Enrollment type of the Individual Enum: "FULL_TIME", "PART_TIME", "INACTIVE", "UNKNOWN" - `transaction_id` (string) Unique ID of this transaction ## Response 400 fields (application/json): - `timestamp` (number) Timestamp in milliseconds - `error_code` (string) MeasureOne Error code - `error_message` (string) Details of the error ## Response 401 fields (application/json): - `timestamp` (number) Timestamp in milliseconds - `error_code` (string) MeasureOne Error code - `error_message` (string) Details of the error ## Response 404 fields (application/json): - `timestamp` (number) Timestamp in milliseconds - `error_code` (string) MeasureOne Error code - `error_message` (string) Details of the error ## Response 409 fields (application/json): - `timestamp` (number) Timestamp in milliseconds Example: 1655227025839 - `http_code` (number) Error status code Example: 409 - `error_code` (string) MeasureOne Error code Example: "MULTIPLE_REPORT_INSTANCES" - `error_message` (string) Details of the error Example: "Multiple instances of the report ACADEMIC_SUMMARY found in the Data Request. Please provide params/metadata in request" ## Response 422 fields (application/json): - `timestamp` (number) Timestamp in milliseconds - `error_code` (string) MeasureOne Error code - `error_message` (string) Details of the error - `reason_codes` (array) List of reason codes. Helps developer understand what error occurred during processing an item. - `reason_codes.code` (string) Reason code applicable. |Reason Code|Description| |--- |--- | |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format. |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable. |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial. |NO_ITEMS| The report could not be generated as there are no items for this Individual. - `reason_codes.description` (string) Description providing details to understand what error occurred during processing an item. - `reason_codes.context` (object) Context to understand where the reason code is applicable - `reason_codes.context.items` (array) List of Items where the reason code is applicable ## Response 500 fields (application/json): - `timestamp` (number) Timestamp in milliseconds - `error_code` (string) MeasureOne Error code - `error_message` (string) Details of the error