| Required role: | REGISUserRole |
| POST | /Academic/Institution/{institution_id}/Students |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InstitutionResponse:
response_status: Optional[ResponseStatus] = None
institution_id: int = 0
institution_name: Optional[str] = None
institution_previous_names: Optional[str] = None
institution_other_names: Optional[str] = None
institution_type: Optional[str] = None
accreditation_status: Optional[str] = None
accreditation_status_notes: Optional[str] = None
related_institutions: Optional[List[str]] = None
accreditation_status_changed_date: Optional[datetime.datetime] = None
gpa_conversion: Optional[str] = None
credit_hour_conversion: Optional[str] = None
addr1: Optional[str] = None
addr2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
country: Optional[str] = None
zip: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentAcademicCredentialResponse:
response_status: Optional[ResponseStatus] = None
uuid: Optional[str] = None
stac_uuid: Optional[str] = None
section_id: Optional[int] = None
course_name: Optional[str] = None
section_code: Optional[str] = None
subject: Optional[str] = None
course_level: Optional[int] = None
title: Optional[str] = None
pretty_title: Optional[str] = None
location: Optional[str] = None
is_audio: bool = False
is_oncampus: bool = False
credit_value: Optional[Decimal] = None
audit_value: Optional[Decimal] = None
is_audit: bool = False
is_pass_fail: bool = False
grade: Optional[str] = None
is_grade_final: bool = False
gpa_credits: Optional[Decimal] = None
grade_points: Optional[Decimal] = None
academic_level: Optional[str] = None
printed_comments: Optional[str] = None
term: Optional[str] = None
reporting_term: Optional[str] = None
reporting_year: Optional[int] = None
current_status: Optional[str] = None
added_by: Optional[str] = None
added_date: Optional[datetime.datetime] = None
changed_by: Optional[str] = None
changed_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentTransferCredentialResponse:
response_status: Optional[ResponseStatus] = None
uuid: Optional[str] = None
stran_uuid: Optional[str] = None
course_name: Optional[str] = None
title: Optional[str] = None
credit_value: Optional[Decimal] = None
is_advanced_standing: bool = False
equivalent_id: int = 0
institution_id: int = 0
added_by: Optional[str] = None
added_date: Optional[datetime.datetime] = None
changed_by: Optional[str] = None
changed_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentTransferCredentialPackageResponse:
response_status: Optional[ResponseStatus] = None
equivalent_id: int = 0
is_advanced_standing: bool = False
institution: Optional[InstitutionResponse] = None
student_academic_credentials: Optional[List[StudentAcademicCredentialResponse]] = None
student_transfer_credentials: Optional[List[StudentTransferCredentialResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentTransferCredentialsResponse:
response_status: Optional[ResponseStatus] = None
regent_id: int = 0
uuid: Optional[str] = None
student_transfer_credential_package: Optional[List[StudentTransferCredentialPackageResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PersonSimpleResponse:
response_status: Optional[ResponseStatus] = None
regent_id: int = 0
ubc_id: Optional[int] = None
uuid: Optional[str] = None
regent_login: Optional[str] = None
first_name: Optional[str] = None
preferred_name: Optional[str] = None
middle_name: Optional[str] = None
last_name: Optional[str] = None
email: Optional[str] = None
phone_home: Optional[str] = None
phone_cell: Optional[str] = None
phone_bus: Optional[str] = None
addr1: Optional[str] = None
addr2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
country: Optional[str] = None
code: Optional[str] = None
citizenship: Optional[str] = None
citizenship_other: Optional[str] = None
permanent_resident: Optional[str] = None
dob: Optional[datetime.datetime] = None
is_student: bool = False
is_faculty: bool = False
is_vendor: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentProgramSimpleResponse:
response_status: Optional[ResponseStatus] = None
regent_id: int = 0
uuid: Optional[str] = None
program_id: int = 0
program_code: Optional[str] = None
program_name: Optional[str] = None
concentration_code: Optional[str] = None
concentration_name: Optional[str] = None
start_date: Optional[datetime.datetime] = None
end_date: Optional[datetime.datetime] = None
catalog: Optional[str] = None
is_active: bool = False
is_graduated: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalDegreeResponse:
id: Optional[int] = None
institution_id: Optional[int] = None
degree_name: Optional[str] = None
degree_override_name: Optional[str] = None
institution_name: Optional[str] = None
graduation_month: Optional[str] = None
start_year: Optional[int] = None
end_year: Optional[int] = None
is_only_in_d365: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalDegreesAdminResponse:
degree_code: Optional[str] = None
degree_name: Optional[str] = None
degree_type: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalDegreesResponse:
response_status: Optional[ResponseStatus] = None
person: Optional[PersonSimpleResponse] = None
gpa: Optional[Decimal] = None
student_programs: Optional[List[StudentProgramSimpleResponse]] = None
degrees: Optional[List[ExternalDegreeResponse]] = None
valid_degrees: Optional[List[ExternalDegreesAdminResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InstitutionStudentsResponse(InstitutionResponse):
student_transfer_credentials: Optional[List[StudentTransferCredentialsResponse]] = None
student_previous_degrees: Optional[List[ExternalDegreesResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InstitutionStudentsRequest:
institution_id: int = 0
Python 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
}