| Required role: | REGISUserRole |
| POST | /Academic/Institution/{institution_id}/Students |
|---|
export class InstitutionResponse
{
public responseStatus: ResponseStatus;
public institution_id: number;
public institution_name: string;
public institution_previous_names: string;
public institution_other_names: string;
public institution_type: string;
public accreditation_status: string;
public accreditation_status_notes: string;
public related_institutions: string[];
public accreditation_status_changed_date?: string;
public gpa_conversion: string;
public credit_hour_conversion: string;
public addr1: string;
public addr2: string;
public city: string;
public state: string;
public country: string;
public zip: string;
public constructor(init?: Partial<InstitutionResponse>) { (Object as any).assign(this, init); }
}
export class StudentAcademicCredentialResponse
{
public responseStatus: ResponseStatus;
public uuid: string;
public stac_uuid: string;
public section_id?: number;
public course_name: string;
public section_code: string;
public subject: string;
public course_level?: number;
public title: string;
public pretty_title: string;
public location: string;
public is_audio: boolean;
public is_oncampus: boolean;
public credit_value?: number;
public audit_value?: number;
public is_audit: boolean;
public is_pass_fail: boolean;
public grade: string;
public is_grade_final: boolean;
public gpa_credits?: number;
public grade_points?: number;
public academic_level: string;
public printed_comments: string;
public term: string;
public reporting_term: string;
public reporting_year?: number;
public current_status: string;
public added_by: string;
public added_date?: string;
public changed_by: string;
public changed_date?: string;
public constructor(init?: Partial<StudentAcademicCredentialResponse>) { (Object as any).assign(this, init); }
}
export class StudentTransferCredentialResponse
{
public responseStatus: ResponseStatus;
public uuid: string;
public stran_uuid: string;
public course_name: string;
public title: string;
public credit_value?: number;
public is_advanced_standing: boolean;
public equivalent_id: number;
public institution_id: number;
public added_by: string;
public added_date?: string;
public changed_by: string;
public changed_date?: string;
public constructor(init?: Partial<StudentTransferCredentialResponse>) { (Object as any).assign(this, init); }
}
export class StudentTransferCredentialPackageResponse
{
public responseStatus: ResponseStatus;
public equivalent_id: number;
public is_advanced_standing: boolean;
public institution: InstitutionResponse;
public studentAcademicCredentials: StudentAcademicCredentialResponse[];
public studentTransferCredentials: StudentTransferCredentialResponse[];
public constructor(init?: Partial<StudentTransferCredentialPackageResponse>) { (Object as any).assign(this, init); }
}
export class StudentTransferCredentialsResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public uuid: string;
public studentTransferCredentialPackage: StudentTransferCredentialPackageResponse[];
public constructor(init?: Partial<StudentTransferCredentialsResponse>) { (Object as any).assign(this, init); }
}
export class PersonSimpleResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public ubc_id?: number;
public uuid: string;
public regent_login: string;
public first_name: string;
public preferred_name: string;
public middle_name: string;
public last_name: string;
public email: string;
public phone_home: string;
public phone_cell: string;
public phone_bus: string;
public addr1: string;
public addr2: string;
public city: string;
public state: string;
public country: string;
public code: string;
public citizenship: string;
public citizenship_other: string;
public permanent_resident: string;
public dob?: string;
public is_student: boolean;
public is_faculty: boolean;
public is_vendor: boolean;
public constructor(init?: Partial<PersonSimpleResponse>) { (Object as any).assign(this, init); }
}
export class StudentProgramSimpleResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public uuid: string;
public program_id: number;
public program_code: string;
public program_name: string;
public concentration_code: string;
public concentration_name: string;
public start_date?: string;
public end_date?: string;
public catalog: string;
public is_active: boolean;
public is_graduated: boolean;
public constructor(init?: Partial<StudentProgramSimpleResponse>) { (Object as any).assign(this, init); }
}
export class ExternalDegreeResponse
{
public id?: number;
public institution_id?: number;
public degree_name: string;
public degree_override_name: string;
public institution_name: string;
public graduation_month: string;
public start_year?: number;
public end_year?: number;
public is_only_in_d365: boolean;
public constructor(init?: Partial<ExternalDegreeResponse>) { (Object as any).assign(this, init); }
}
export class ExternalDegreesAdminResponse
{
public degree_code: string;
public degree_name: string;
public degree_type: string;
public constructor(init?: Partial<ExternalDegreesAdminResponse>) { (Object as any).assign(this, init); }
}
export class ExternalDegreesResponse
{
public responseStatus: ResponseStatus;
public person: PersonSimpleResponse;
public gpa?: number;
public student_programs: StudentProgramSimpleResponse[];
public degrees: ExternalDegreeResponse[];
public valid_degrees: ExternalDegreesAdminResponse[];
public constructor(init?: Partial<ExternalDegreesResponse>) { (Object as any).assign(this, init); }
}
export class InstitutionStudentsResponse extends InstitutionResponse
{
public student_transfer_credentials: StudentTransferCredentialsResponse[];
public student_previous_degrees: ExternalDegreesResponse[];
public constructor(init?: Partial<InstitutionStudentsResponse>) { super(init); (Object as any).assign(this, init); }
}
export class InstitutionStudentsRequest
{
public institution_id: number;
public constructor(init?: Partial<InstitutionStudentsRequest>) { (Object as any).assign(this, init); }
}
TypeScript 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
}