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