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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<InstitutionStudentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<institution_id>0</institution_id>
</InstitutionStudentsRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <InstitutionStudentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <accreditation_status>String</accreditation_status> <accreditation_status_changed_date>0001-01-01T00:00:00</accreditation_status_changed_date> <accreditation_status_notes>String</accreditation_status_notes> <addr1>String</addr1> <addr2>String</addr2> <city>String</city> <country>String</country> <credit_hour_conversion>String</credit_hour_conversion> <gpa_conversion>String</gpa_conversion> <institution_id>0</institution_id> <institution_name>String</institution_name> <institution_other_names>String</institution_other_names> <institution_previous_names>String</institution_previous_names> <institution_type>String</institution_type> <related_institutions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </related_institutions> <state>String</state> <zip>String</zip> <student_previous_degrees> <ExternalDegreesResponse> <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types"> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:Message>String</d4p1:Message> <d4p1:StackTrace>String</d4p1:StackTrace> <d4p1:Errors> <d4p1:ResponseError> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:FieldName>String</d4p1:FieldName> <d4p1:Message>String</d4p1:Message> <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d4p1:Meta> </d4p1:ResponseError> </d4p1:Errors> <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d4p1:Meta> </ResponseStatus> <degrees> <ExternalDegreeResponse> <degree_name>String</degree_name> <degree_override_name>String</degree_override_name> <end_year>0</end_year> <graduation_month>String</graduation_month> <id>0</id> <institution_id>0</institution_id> <institution_name>String</institution_name> <is_only_in_d365>false</is_only_in_d365> <start_year>0</start_year> </ExternalDegreeResponse> </degrees> <gpa>0</gpa> <person> <ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types"> <d5p1:ErrorCode>String</d5p1:ErrorCode> <d5p1:Message>String</d5p1:Message> <d5p1:StackTrace>String</d5p1:StackTrace> <d5p1:Errors> <d5p1:ResponseError> <d5p1:ErrorCode>String</d5p1:ErrorCode> <d5p1:FieldName>String</d5p1:FieldName> <d5p1:Message>String</d5p1:Message> <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>String</d8p1:Key> <d8p1:Value>String</d8p1:Value> </d8p1:KeyValueOfstringstring> </d5p1:Meta> </d5p1:ResponseError> </d5p1:Errors> <d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:KeyValueOfstringstring> <d6p1:Key>String</d6p1:Key> <d6p1:Value>String</d6p1:Value> </d6p1:KeyValueOfstringstring> </d5p1:Meta> </ResponseStatus> <addr1>String</addr1> <addr2>String</addr2> <citizenship>String</citizenship> <citizenship_other>String</citizenship_other> <city>String</city> <code>String</code> <country>String</country> <dob>0001-01-01T00:00:00</dob> <email>String</email> <first_name>String</first_name> <is_faculty>false</is_faculty> <is_student>false</is_student> <is_vendor>false</is_vendor> <last_name>String</last_name> <middle_name>String</middle_name> <permanent_resident>String</permanent_resident> <phone_bus>String</phone_bus> <phone_cell>String</phone_cell> <phone_home>String</phone_home> <preferred_name>String</preferred_name> <regent_id>0</regent_id> <regent_login>String</regent_login> <state>String</state> <ubc_id>0</ubc_id> <uuid>String</uuid> </person> <student_programs> <StudentProgramSimpleResponse> <ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types"> <d6p1:ErrorCode>String</d6p1:ErrorCode> <d6p1:Message>String</d6p1:Message> <d6p1:StackTrace>String</d6p1:StackTrace> <d6p1:Errors> <d6p1:ResponseError> <d6p1:ErrorCode>String</d6p1:ErrorCode> <d6p1:FieldName>String</d6p1:FieldName> <d6p1:Message>String</d6p1:Message> <d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d9p1:KeyValueOfstringstring> <d9p1:Key>String</d9p1:Key> <d9p1:Value>String</d9p1:Value> </d9p1:KeyValueOfstringstring> </d6p1:Meta> </d6p1:ResponseError> </d6p1:Errors> <d6p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d6p1:Meta> </ResponseStatus> <catalog>String</catalog> <concentration_code>String</concentration_code> <concentration_name>String</concentration_name> <end_date>0001-01-01T00:00:00</end_date> <is_active>false</is_active> <is_graduated>false</is_graduated> <program_code>String</program_code> <program_id>0</program_id> <program_name>String</program_name> <regent_id>0</regent_id> <start_date>0001-01-01T00:00:00</start_date> <uuid>String</uuid> </StudentProgramSimpleResponse> </student_programs> <valid_degrees> <ExternalDegreesAdminResponse> <degree_code>String</degree_code> <degree_name>String</degree_name> <degree_type>String</degree_type> </ExternalDegreesAdminResponse> </valid_degrees> </ExternalDegreesResponse> </student_previous_degrees> <student_transfer_credentials> <StudentTransferCredentialsResponse> <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types"> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:Message>String</d4p1:Message> <d4p1:StackTrace>String</d4p1:StackTrace> <d4p1:Errors> <d4p1:ResponseError> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:FieldName>String</d4p1:FieldName> <d4p1:Message>String</d4p1:Message> <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d4p1:Meta> </d4p1:ResponseError> </d4p1:Errors> <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d4p1:Meta> </ResponseStatus> <regent_id>0</regent_id> <studentTransferCredentialPackage> <StudentTransferCredentialPackageResponse> <ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types"> <d6p1:ErrorCode>String</d6p1:ErrorCode> <d6p1:Message>String</d6p1:Message> <d6p1:StackTrace>String</d6p1:StackTrace> <d6p1:Errors> <d6p1:ResponseError> <d6p1:ErrorCode>String</d6p1:ErrorCode> <d6p1:FieldName>String</d6p1:FieldName> <d6p1:Message>String</d6p1:Message> <d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d9p1:KeyValueOfstringstring> <d9p1:Key>String</d9p1:Key> <d9p1:Value>String</d9p1:Value> </d9p1:KeyValueOfstringstring> </d6p1:Meta> </d6p1:ResponseError> </d6p1:Errors> <d6p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d6p1:Meta> </ResponseStatus> <equivalent_id>0</equivalent_id> <institution> <ResponseStatus xmlns:d7p1="http://schemas.servicestack.net/types"> <d7p1:ErrorCode>String</d7p1:ErrorCode> <d7p1:Message>String</d7p1:Message> <d7p1:StackTrace>String</d7p1:StackTrace> <d7p1:Errors> <d7p1:ResponseError> <d7p1:ErrorCode>String</d7p1:ErrorCode> <d7p1:FieldName>String</d7p1:FieldName> <d7p1:Message>String</d7p1:Message> <d7p1:Meta xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d10p1:KeyValueOfstringstring> <d10p1:Key>String</d10p1:Key> <d10p1:Value>String</d10p1:Value> </d10p1:KeyValueOfstringstring> </d7p1:Meta> </d7p1:ResponseError> </d7p1:Errors> <d7p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>String</d8p1:Key> <d8p1:Value>String</d8p1:Value> </d8p1:KeyValueOfstringstring> </d7p1:Meta> </ResponseStatus> <accreditation_status>String</accreditation_status> <accreditation_status_changed_date>0001-01-01T00:00:00</accreditation_status_changed_date> <accreditation_status_notes>String</accreditation_status_notes> <addr1>String</addr1> <addr2>String</addr2> <city>String</city> <country>String</country> <credit_hour_conversion>String</credit_hour_conversion> <gpa_conversion>String</gpa_conversion> <institution_id>0</institution_id> <institution_name>String</institution_name> <institution_other_names>String</institution_other_names> <institution_previous_names>String</institution_previous_names> <institution_type>String</institution_type> <related_institutions xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:string>String</d7p1:string> </related_institutions> <state>String</state> <zip>String</zip> </institution> <is_advanced_standing>false</is_advanced_standing> <studentAcademicCredentials> <StudentAcademicCredentialResponse> <ResponseStatus xmlns:d8p1="http://schemas.servicestack.net/types"> <d8p1:ErrorCode>String</d8p1:ErrorCode> <d8p1:Message>String</d8p1:Message> <d8p1:StackTrace>String</d8p1:StackTrace> <d8p1:Errors> <d8p1:ResponseError> <d8p1:ErrorCode>String</d8p1:ErrorCode> <d8p1:FieldName>String</d8p1:FieldName> <d8p1:Message>String</d8p1:Message> <d8p1:Meta xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d11p1:KeyValueOfstringstring> <d11p1:Key>String</d11p1:Key> <d11p1:Value>String</d11p1:Value> </d11p1:KeyValueOfstringstring> </d8p1:Meta> </d8p1:ResponseError> </d8p1:Errors> <d8p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d9p1:KeyValueOfstringstring> <d9p1:Key>String</d9p1:Key> <d9p1:Value>String</d9p1:Value> </d9p1:KeyValueOfstringstring> </d8p1:Meta> </ResponseStatus> <academic_level>String</academic_level> <added_by>String</added_by> <added_date>0001-01-01T00:00:00</added_date> <audit_value>0</audit_value> <changed_by>String</changed_by> <changed_date>0001-01-01T00:00:00</changed_date> <course_level>0</course_level> <course_name>String</course_name> <credit_value>0</credit_value> <current_status>String</current_status> <gpa_credits>0</gpa_credits> <grade>String</grade> <grade_points>0</grade_points> <is_audio>false</is_audio> <is_audit>false</is_audit> <is_grade_final>false</is_grade_final> <is_oncampus>false</is_oncampus> <is_pass_fail>false</is_pass_fail> <location>String</location> <pretty_title>String</pretty_title> <printed_comments>String</printed_comments> <reporting_term>String</reporting_term> <reporting_year>0</reporting_year> <section_code>String</section_code> <section_id>0</section_id> <stac_uuid>String</stac_uuid> <subject>String</subject> <term>String</term> <title>String</title> <uuid>String</uuid> </StudentAcademicCredentialResponse> </studentAcademicCredentials> <studentTransferCredentials> <StudentTransferCredentialResponse> <ResponseStatus xmlns:d8p1="http://schemas.servicestack.net/types"> <d8p1:ErrorCode>String</d8p1:ErrorCode> <d8p1:Message>String</d8p1:Message> <d8p1:StackTrace>String</d8p1:StackTrace> <d8p1:Errors> <d8p1:ResponseError> <d8p1:ErrorCode>String</d8p1:ErrorCode> <d8p1:FieldName>String</d8p1:FieldName> <d8p1:Message>String</d8p1:Message> <d8p1:Meta xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d11p1:KeyValueOfstringstring> <d11p1:Key>String</d11p1:Key> <d11p1:Value>String</d11p1:Value> </d11p1:KeyValueOfstringstring> </d8p1:Meta> </d8p1:ResponseError> </d8p1:Errors> <d8p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d9p1:KeyValueOfstringstring> <d9p1:Key>String</d9p1:Key> <d9p1:Value>String</d9p1:Value> </d9p1:KeyValueOfstringstring> </d8p1:Meta> </ResponseStatus> <added_by>String</added_by> <added_date>0001-01-01T00:00:00</added_date> <changed_by>String</changed_by> <changed_date>0001-01-01T00:00:00</changed_date> <course_name>String</course_name> <credit_value>0</credit_value> <equivalent_id>0</equivalent_id> <institution_id>0</institution_id> <is_advanced_standing>false</is_advanced_standing> <stran_uuid>String</stran_uuid> <title>String</title> <uuid>String</uuid> </StudentTransferCredentialResponse> </studentTransferCredentials> </StudentTransferCredentialPackageResponse> </studentTransferCredentialPackage> <uuid>String</uuid> </StudentTransferCredentialsResponse> </student_transfer_credentials> </InstitutionStudentsResponse>