Required role: | REGISUserRole |
POST | /StudentTransferCredentials/{uuid} |
---|
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 StudentTransferCredentialsRequest
{
public uuid: string;
public constructor(init?: Partial<StudentTransferCredentialsRequest>) { (Object as any).assign(this, init); }
}
TypeScript StudentTransferCredentialsRequest 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 /StudentTransferCredentials/{uuid} HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<StudentTransferCredentialsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<uuid>String</uuid>
</StudentTransferCredentialsRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <StudentTransferCredentialsResponse 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> <regent_id>0</regent_id> <studentTransferCredentialPackage> <StudentTransferCredentialPackageResponse> <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> <equivalent_id>0</equivalent_id> <institution> <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> <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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </related_institutions> <state>String</state> <zip>String</zip> </institution> <is_advanced_standing>false</is_advanced_standing> <studentAcademicCredentials> <StudentAcademicCredentialResponse> <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> <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: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> <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>