| Required role: | REGISUserRole |
| POST | /Academic/Institution/{institution_id}/Students |
|---|
"use strict";
export class InstitutionResponse {
/** @param {{responseStatus?:ResponseStatus,institution_id?:number,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?:string,gpa_conversion?:string,credit_hour_conversion?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,zip?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
institution_id;
/** @type {string} */
institution_name;
/** @type {string} */
institution_previous_names;
/** @type {string} */
institution_other_names;
/** @type {string} */
institution_type;
/** @type {string} */
accreditation_status;
/** @type {string} */
accreditation_status_notes;
/** @type {string[]} */
related_institutions;
/** @type {?string} */
accreditation_status_changed_date;
/** @type {string} */
gpa_conversion;
/** @type {string} */
credit_hour_conversion;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
country;
/** @type {string} */
zip;
}
export class StudentAcademicCredentialResponse {
/** @param {{responseStatus?:ResponseStatus,uuid?:string,stac_uuid?:string,section_id?:number,course_name?:string,section_code?:string,subject?:string,course_level?:number,title?:string,pretty_title?:string,location?:string,is_audio?:boolean,is_oncampus?:boolean,credit_value?:number,audit_value?:number,is_audit?:boolean,is_pass_fail?:boolean,grade?:string,is_grade_final?:boolean,gpa_credits?:number,grade_points?:number,academic_level?:string,printed_comments?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
uuid;
/** @type {string} */
stac_uuid;
/** @type {?number} */
section_id;
/** @type {string} */
course_name;
/** @type {string} */
section_code;
/** @type {string} */
subject;
/** @type {?number} */
course_level;
/** @type {string} */
title;
/** @type {string} */
pretty_title;
/** @type {string} */
location;
/** @type {boolean} */
is_audio;
/** @type {boolean} */
is_oncampus;
/** @type {?number} */
credit_value;
/** @type {?number} */
audit_value;
/** @type {boolean} */
is_audit;
/** @type {boolean} */
is_pass_fail;
/** @type {string} */
grade;
/** @type {boolean} */
is_grade_final;
/** @type {?number} */
gpa_credits;
/** @type {?number} */
grade_points;
/** @type {string} */
academic_level;
/** @type {string} */
printed_comments;
/** @type {string} */
term;
/** @type {string} */
reporting_term;
/** @type {?number} */
reporting_year;
/** @type {string} */
current_status;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
}
export class StudentTransferCredentialResponse {
/** @param {{responseStatus?:ResponseStatus,uuid?:string,stran_uuid?:string,course_name?:string,title?:string,credit_value?:number,is_advanced_standing?:boolean,equivalent_id?:number,institution_id?:number,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
uuid;
/** @type {string} */
stran_uuid;
/** @type {string} */
course_name;
/** @type {string} */
title;
/** @type {?number} */
credit_value;
/** @type {boolean} */
is_advanced_standing;
/** @type {number} */
equivalent_id;
/** @type {number} */
institution_id;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
}
export class StudentTransferCredentialPackageResponse {
/** @param {{responseStatus?:ResponseStatus,equivalent_id?:number,is_advanced_standing?:boolean,institution?:InstitutionResponse,studentAcademicCredentials?:StudentAcademicCredentialResponse[],studentTransferCredentials?:StudentTransferCredentialResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
equivalent_id;
/** @type {boolean} */
is_advanced_standing;
/** @type {InstitutionResponse} */
institution;
/** @type {StudentAcademicCredentialResponse[]} */
studentAcademicCredentials;
/** @type {StudentTransferCredentialResponse[]} */
studentTransferCredentials;
}
export class StudentTransferCredentialsResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,studentTransferCredentialPackage?:StudentTransferCredentialPackageResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {StudentTransferCredentialPackageResponse[]} */
studentTransferCredentialPackage;
}
export class PersonSimpleResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,ubc_id?:number,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?:string,is_student?:boolean,is_faculty?:boolean,is_vendor?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {?number} */
ubc_id;
/** @type {string} */
uuid;
/** @type {string} */
regent_login;
/** @type {string} */
first_name;
/** @type {string} */
preferred_name;
/** @type {string} */
middle_name;
/** @type {string} */
last_name;
/** @type {string} */
email;
/** @type {string} */
phone_home;
/** @type {string} */
phone_cell;
/** @type {string} */
phone_bus;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
country;
/** @type {string} */
code;
/** @type {string} */
citizenship;
/** @type {string} */
citizenship_other;
/** @type {string} */
permanent_resident;
/** @type {?string} */
dob;
/** @type {boolean} */
is_student;
/** @type {boolean} */
is_faculty;
/** @type {boolean} */
is_vendor;
}
export class StudentProgramSimpleResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,program_id?:number,program_code?:string,program_name?:string,concentration_code?:string,concentration_name?:string,start_date?:string,end_date?:string,catalog?:string,is_active?:boolean,is_graduated?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {number} */
program_id;
/** @type {string} */
program_code;
/** @type {string} */
program_name;
/** @type {string} */
concentration_code;
/** @type {string} */
concentration_name;
/** @type {?string} */
start_date;
/** @type {?string} */
end_date;
/** @type {string} */
catalog;
/** @type {boolean} */
is_active;
/** @type {boolean} */
is_graduated;
}
export class ExternalDegreeResponse {
/** @param {{id?:number,institution_id?:number,degree_name?:string,degree_override_name?:string,institution_name?:string,graduation_month?:string,start_year?:number,end_year?:number,is_only_in_d365?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
id;
/** @type {?number} */
institution_id;
/** @type {string} */
degree_name;
/** @type {string} */
degree_override_name;
/** @type {string} */
institution_name;
/** @type {string} */
graduation_month;
/** @type {?number} */
start_year;
/** @type {?number} */
end_year;
/** @type {boolean} */
is_only_in_d365;
}
export class ExternalDegreesAdminResponse {
/** @param {{degree_code?:string,degree_name?:string,degree_type?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
degree_code;
/** @type {string} */
degree_name;
/** @type {string} */
degree_type;
}
export class ExternalDegreesResponse {
/** @param {{responseStatus?:ResponseStatus,person?:PersonSimpleResponse,gpa?:number,student_programs?:StudentProgramSimpleResponse[],degrees?:ExternalDegreeResponse[],valid_degrees?:ExternalDegreesAdminResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {PersonSimpleResponse} */
person;
/** @type {?number} */
gpa;
/** @type {StudentProgramSimpleResponse[]} */
student_programs;
/** @type {ExternalDegreeResponse[]} */
degrees;
/** @type {ExternalDegreesAdminResponse[]} */
valid_degrees;
}
export class InstitutionStudentsResponse extends InstitutionResponse {
/** @param {{student_transfer_credentials?:StudentTransferCredentialsResponse[],student_previous_degrees?:ExternalDegreesResponse[],responseStatus?:ResponseStatus,institution_id?:number,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?:string,gpa_conversion?:string,credit_hour_conversion?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,zip?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {StudentTransferCredentialsResponse[]} */
student_transfer_credentials;
/** @type {ExternalDegreesResponse[]} */
student_previous_degrees;
}
export class InstitutionStudentsRequest {
/** @param {{institution_id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
institution_id;
}
JavaScript InstitutionStudentsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
institution_id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
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-01,
changed_by: String,
changed_date: 0001-01-01
}
],
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-01,
changed_by: String,
changed_date: 0001-01-01
}
]
}
]
}
],
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-01,
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-01,
end_date: 0001-01-01,
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-01,
gpa_conversion: String,
credit_hour_conversion: String,
addr1: String,
addr2: String,
city: String,
state: String,
country: String,
zip: String
}