regis

<back to all web services

StudentTransferCredentialsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
				}
			]
		}
	]
}