| Required role: | REGISUserRole |
| POST | /Academic/Institution/{institution_id}/Students |
|---|
namespace regis.ClassLibrary.Requests
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type InstitutionResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val institution_id:Int32 = new Int32() with get,set
member val institution_name:String = null with get,set
member val institution_previous_names:String = null with get,set
member val institution_other_names:String = null with get,set
member val institution_type:String = null with get,set
member val accreditation_status:String = null with get,set
member val accreditation_status_notes:String = null with get,set
member val related_institutions:ResizeArray<String> = new ResizeArray<String>() with get,set
member val accreditation_status_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val gpa_conversion:String = null with get,set
member val credit_hour_conversion:String = null with get,set
member val addr1:String = null with get,set
member val addr2:String = null with get,set
member val city:String = null with get,set
member val state:String = null with get,set
member val country:String = null with get,set
member val zip:String = null with get,set
[<AllowNullLiteral>]
type StudentAcademicCredentialResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val uuid:String = null with get,set
member val stac_uuid:String = null with get,set
member val section_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val course_name:String = null with get,set
member val section_code:String = null with get,set
member val subject:String = null with get,set
member val course_level:Nullable<Int32> = new Nullable<Int32>() with get,set
member val title:String = null with get,set
member val pretty_title:String = null with get,set
member val location:String = null with get,set
member val is_audio:Boolean = new Boolean() with get,set
member val is_oncampus:Boolean = new Boolean() with get,set
member val credit_value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val audit_value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val is_audit:Boolean = new Boolean() with get,set
member val is_pass_fail:Boolean = new Boolean() with get,set
member val grade:String = null with get,set
member val is_grade_final:Boolean = new Boolean() with get,set
member val gpa_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val grade_points:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val academic_level:String = null with get,set
member val printed_comments:String = null with get,set
member val term:String = null with get,set
member val reporting_term:String = null with get,set
member val reporting_year:Nullable<Int32> = new Nullable<Int32>() with get,set
member val current_status:String = null with get,set
member val added_by:String = null with get,set
member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val changed_by:String = null with get,set
member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type StudentTransferCredentialResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val uuid:String = null with get,set
member val stran_uuid:String = null with get,set
member val course_name:String = null with get,set
member val title:String = null with get,set
member val credit_value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val is_advanced_standing:Boolean = new Boolean() with get,set
member val equivalent_id:Int32 = new Int32() with get,set
member val institution_id:Int32 = new Int32() with get,set
member val added_by:String = null with get,set
member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val changed_by:String = null with get,set
member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type StudentTransferCredentialPackageResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val equivalent_id:Int32 = new Int32() with get,set
member val is_advanced_standing:Boolean = new Boolean() with get,set
member val institution:InstitutionResponse = null with get,set
member val studentAcademicCredentials:ResizeArray<StudentAcademicCredentialResponse> = new ResizeArray<StudentAcademicCredentialResponse>() with get,set
member val studentTransferCredentials:ResizeArray<StudentTransferCredentialResponse> = new ResizeArray<StudentTransferCredentialResponse>() with get,set
[<AllowNullLiteral>]
type StudentTransferCredentialsResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val uuid:String = null with get,set
member val studentTransferCredentialPackage:ResizeArray<StudentTransferCredentialPackageResponse> = new ResizeArray<StudentTransferCredentialPackageResponse>() with get,set
[<AllowNullLiteral>]
type PersonSimpleResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val ubc_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val uuid:String = null with get,set
member val regent_login:String = null with get,set
member val first_name:String = null with get,set
member val preferred_name:String = null with get,set
member val middle_name:String = null with get,set
member val last_name:String = null with get,set
member val email:String = null with get,set
member val phone_home:String = null with get,set
member val phone_cell:String = null with get,set
member val phone_bus:String = null with get,set
member val addr1:String = null with get,set
member val addr2:String = null with get,set
member val city:String = null with get,set
member val state:String = null with get,set
member val country:String = null with get,set
member val code:String = null with get,set
member val citizenship:String = null with get,set
member val citizenship_other:String = null with get,set
member val permanent_resident:String = null with get,set
member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val is_student:Boolean = new Boolean() with get,set
member val is_faculty:Boolean = new Boolean() with get,set
member val is_vendor:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type StudentProgramSimpleResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val uuid:String = null with get,set
member val program_id:Int32 = new Int32() with get,set
member val program_code:String = null with get,set
member val program_name:String = null with get,set
member val concentration_code:String = null with get,set
member val concentration_name:String = null with get,set
member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val catalog:String = null with get,set
member val is_active:Boolean = new Boolean() with get,set
member val is_graduated:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ExternalDegreeResponse() =
member val id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val institution_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val degree_name:String = null with get,set
member val degree_override_name:String = null with get,set
member val institution_name:String = null with get,set
member val graduation_month:String = null with get,set
member val start_year:Nullable<Int32> = new Nullable<Int32>() with get,set
member val end_year:Nullable<Int32> = new Nullable<Int32>() with get,set
member val is_only_in_d365:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ExternalDegreesAdminResponse() =
member val degree_code:String = null with get,set
member val degree_name:String = null with get,set
member val degree_type:String = null with get,set
[<AllowNullLiteral>]
type ExternalDegreesResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val person:PersonSimpleResponse = null with get,set
member val gpa:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val student_programs:ResizeArray<StudentProgramSimpleResponse> = new ResizeArray<StudentProgramSimpleResponse>() with get,set
member val degrees:ResizeArray<ExternalDegreeResponse> = new ResizeArray<ExternalDegreeResponse>() with get,set
member val valid_degrees:ResizeArray<ExternalDegreesAdminResponse> = new ResizeArray<ExternalDegreesAdminResponse>() with get,set
[<AllowNullLiteral>]
type InstitutionStudentsResponse() =
inherit InstitutionResponse()
member val student_transfer_credentials:ResizeArray<StudentTransferCredentialsResponse> = new ResizeArray<StudentTransferCredentialsResponse>() with get,set
member val student_previous_degrees:ResizeArray<ExternalDegreesResponse> = new ResizeArray<ExternalDegreesResponse>() with get,set
[<AllowNullLiteral>]
type InstitutionStudentsRequest() =
member val institution_id:Int32 = new Int32() with get,set
F# 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
}