| Required role: | REGISUserRole |
| POST | /Academic/Institution/{institution_id}/Students |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class InstitutionStudentsRequest
{
var institution_id:Int? = null
}
open class InstitutionStudentsResponse : InstitutionResponse()
{
var student_transfer_credentials:ArrayList<StudentTransferCredentialsResponse> = ArrayList<StudentTransferCredentialsResponse>()
var student_previous_degrees:ArrayList<ExternalDegreesResponse> = ArrayList<ExternalDegreesResponse>()
}
open class InstitutionResponse
{
var responseStatus:ResponseStatus? = null
var institution_id:Int? = null
var institution_name:String? = null
var institution_previous_names:String? = null
var institution_other_names:String? = null
var institution_type:String? = null
var accreditation_status:String? = null
var accreditation_status_notes:String? = null
var related_institutions:ArrayList<String> = ArrayList<String>()
var accreditation_status_changed_date:Date? = null
var gpa_conversion:String? = null
var credit_hour_conversion:String? = null
var addr1:String? = null
var addr2:String? = null
var city:String? = null
var state:String? = null
var country:String? = null
var zip:String? = null
}
open class StudentTransferCredentialsResponse
{
var responseStatus:ResponseStatus? = null
var regent_id:Int? = null
var uuid:String? = null
var studentTransferCredentialPackage:ArrayList<StudentTransferCredentialPackageResponse> = ArrayList<StudentTransferCredentialPackageResponse>()
}
open class StudentTransferCredentialPackageResponse
{
var responseStatus:ResponseStatus? = null
var equivalent_id:Int? = null
var is_advanced_standing:Boolean? = null
var institution:InstitutionResponse? = null
var studentAcademicCredentials:ArrayList<StudentAcademicCredentialResponse> = ArrayList<StudentAcademicCredentialResponse>()
var studentTransferCredentials:ArrayList<StudentTransferCredentialResponse> = ArrayList<StudentTransferCredentialResponse>()
}
open class StudentAcademicCredentialResponse
{
var responseStatus:ResponseStatus? = null
var uuid:String? = null
var stac_uuid:String? = null
var section_id:Int? = null
var course_name:String? = null
var section_code:String? = null
var subject:String? = null
var course_level:Int? = null
var title:String? = null
var pretty_title:String? = null
var location:String? = null
var is_audio:Boolean? = null
var is_oncampus:Boolean? = null
var credit_value:BigDecimal? = null
var audit_value:BigDecimal? = null
var is_audit:Boolean? = null
var is_pass_fail:Boolean? = null
var grade:String? = null
var is_grade_final:Boolean? = null
var gpa_credits:BigDecimal? = null
var grade_points:BigDecimal? = null
var academic_level:String? = null
var printed_comments:String? = null
var term:String? = null
var reporting_term:String? = null
var reporting_year:Int? = null
var current_status:String? = null
var added_by:String? = null
var added_date:Date? = null
var changed_by:String? = null
var changed_date:Date? = null
}
open class StudentTransferCredentialResponse
{
var responseStatus:ResponseStatus? = null
var uuid:String? = null
var stran_uuid:String? = null
var course_name:String? = null
var title:String? = null
var credit_value:BigDecimal? = null
var is_advanced_standing:Boolean? = null
var equivalent_id:Int? = null
var institution_id:Int? = null
var added_by:String? = null
var added_date:Date? = null
var changed_by:String? = null
var changed_date:Date? = null
}
open class ExternalDegreesResponse
{
var responseStatus:ResponseStatus? = null
var person:PersonSimpleResponse? = null
var gpa:BigDecimal? = null
var student_programs:ArrayList<StudentProgramSimpleResponse> = ArrayList<StudentProgramSimpleResponse>()
var degrees:ArrayList<ExternalDegreeResponse> = ArrayList<ExternalDegreeResponse>()
var valid_degrees:ArrayList<ExternalDegreesAdminResponse> = ArrayList<ExternalDegreesAdminResponse>()
}
open class PersonSimpleResponse
{
var responseStatus:ResponseStatus? = null
var regent_id:Int? = null
var ubc_id:Int? = null
var uuid:String? = null
var regent_login:String? = null
var first_name:String? = null
var preferred_name:String? = null
var middle_name:String? = null
var last_name:String? = null
var email:String? = null
var phone_home:String? = null
var phone_cell:String? = null
var phone_bus:String? = null
var addr1:String? = null
var addr2:String? = null
var city:String? = null
var state:String? = null
var country:String? = null
var code:String? = null
var citizenship:String? = null
var citizenship_other:String? = null
var permanent_resident:String? = null
var dob:Date? = null
var is_student:Boolean? = null
var is_faculty:Boolean? = null
var is_vendor:Boolean? = null
}
open class StudentProgramSimpleResponse
{
var responseStatus:ResponseStatus? = null
var regent_id:Int? = null
var uuid:String? = null
var program_id:Int? = null
var program_code:String? = null
var program_name:String? = null
var concentration_code:String? = null
var concentration_name:String? = null
var start_date:Date? = null
var end_date:Date? = null
var catalog:String? = null
var is_active:Boolean? = null
var is_graduated:Boolean? = null
}
open class ExternalDegreeResponse
{
var id:Int? = null
var institution_id:Int? = null
var degree_name:String? = null
var degree_override_name:String? = null
var institution_name:String? = null
var graduation_month:String? = null
var start_year:Int? = null
var end_year:Int? = null
var is_only_in_d365:Boolean? = null
}
open class ExternalDegreesAdminResponse
{
var degree_code:String? = null
var degree_name:String? = null
var degree_type:String? = null
}
Kotlin 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
}