regis

<back to all web services

InstitutionStudentsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/{institution_id}/Students
InstitutionStudentsRequest Parameters:
NameParameterData TypeRequiredDescription
institution_idpathintNo
InstitutionStudentsResponse Parameters:
NameParameterData TypeRequiredDescription
student_transfer_credentialsformList<StudentTransferCredentialsResponse>No
student_previous_degreesformList<ExternalDegreesResponse>No
InstitutionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
institution_idformintNo
institution_nameformstringNo
institution_previous_namesformstringNo
institution_other_namesformstringNo
institution_typeformstringNo
accreditation_statusformstringNo
accreditation_status_notesformstringNo
related_institutionsformList<string>No
accreditation_status_changed_dateformDateTime?No
gpa_conversionformstringNo
credit_hour_conversionformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
zipformstringNo
StudentTransferCredentialsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
studentTransferCredentialPackageformList<StudentTransferCredentialPackageResponse>No
StudentTransferCredentialPackageResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
equivalent_idformintNo
is_advanced_standingformboolNo
institutionformInstitutionResponseNo
studentAcademicCredentialsformList<StudentAcademicCredentialResponse>No
studentTransferCredentialsformList<StudentTransferCredentialResponse>No
StudentAcademicCredentialResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
stac_uuidformstringNo
section_idformint?No
course_nameformstringNo
section_codeformstringNo
subjectformstringNo
course_levelformint?No
titleformstringNo
pretty_titleformstringNo
locationformstringNo
is_audioformboolNo
is_oncampusformboolNo
credit_valueformdecimal?No
audit_valueformdecimal?No
is_auditformboolNo
is_pass_failformboolNo
gradeformstringNo
is_grade_finalformboolNo
gpa_creditsformdecimal?No
grade_pointsformdecimal?No
academic_levelformstringNo
printed_commentsformstringNo
termformstringNo
reporting_termformstringNo
reporting_yearformint?No
current_statusformstringNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
StudentTransferCredentialResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
stran_uuidformstringNo
course_nameformstringNo
titleformstringNo
credit_valueformdecimal?No
is_advanced_standingformboolNo
equivalent_idformintNo
institution_idformintNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
ExternalDegreesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
personformPersonSimpleResponseNo
gpaformdecimal?No
student_programsformList<StudentProgramSimpleResponse>No
degreesformList<ExternalDegreeResponse>No
valid_degreesformList<ExternalDegreesAdminResponse>No
PersonSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
ubc_idformint?No
uuidformstringNo
regent_loginformstringNo
first_nameformstringNo
preferred_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
emailformstringNo
phone_homeformstringNo
phone_cellformstringNo
phone_busformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
dobformDateTime?No
is_studentformboolNo
is_facultyformboolNo
is_vendorformboolNo
StudentProgramSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
program_idformintNo
program_codeformstringNo
program_nameformstringNo
concentration_codeformstringNo
concentration_nameformstringNo
start_dateformDateTime?No
end_dateformDateTime?No
catalogformstringNo
is_activeformboolNo
is_graduatedformboolNo
ExternalDegreeResponse Parameters:
NameParameterData TypeRequiredDescription
idformint?No
institution_idformint?No
degree_nameformstringNo
degree_override_nameformstringNo
institution_nameformstringNo
graduation_monthformstringNo
start_yearformint?No
end_yearformint?No
is_only_in_d365formboolNo
ExternalDegreesAdminResponse Parameters:
NameParameterData TypeRequiredDescription
degree_codeformstringNo
degree_nameformstringNo
degree_typeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Academic/Institution/{institution_id}/Students HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"institution_id":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"student_transfer_credentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","studentTransferCredentialPackage":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"equivalent_id":0,"is_advanced_standing":false,"institution":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"},"studentAcademicCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stac_uuid":"String","section_id":0,"course_name":"String","section_code":"String","subject":"String","course_level":0,"title":"String","pretty_title":"String","location":"String","is_audio":false,"is_oncampus":false,"credit_value":0,"audit_value":0,"is_audit":false,"is_pass_fail":false,"grade":"String","is_grade_final":false,"gpa_credits":0,"grade_points":0,"academic_level":"String","printed_comments":"String","term":"String","reporting_term":"String","reporting_year":0,"current_status":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}],"studentTransferCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stran_uuid":"String","course_name":"String","title":"String","credit_value":0,"is_advanced_standing":false,"equivalent_id":0,"institution_id":0,"added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}]}]}],"student_previous_degrees":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"person":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"ubc_id":0,"uuid":"String","regent_login":"String","first_name":"String","preferred_name":"String","middle_name":"String","last_name":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","is_student":false,"is_faculty":false,"is_vendor":false},"gpa":0,"student_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}],"degrees":[{"id":0,"institution_id":0,"degree_name":"String","degree_override_name":"String","institution_name":"String","graduation_month":"String","start_year":0,"end_year":0,"is_only_in_d365":false}],"valid_degrees":[{"degree_code":"String","degree_name":"String","degree_type":"String"}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"}