regis

<back to all web services

StudentTransferCredentialPackageCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentTransferCredentials/{uuid}/Create

export class StudentTransferCredentialCreateRequest
{
    public uuid: string;
    public course_name: string;
    public title: string;
    public credit_value: number;
    public authorizing_uuid: string;

    public constructor(init?: Partial<StudentTransferCredentialCreateRequest>) { (Object as any).assign(this, init); }
}

export class StudentAcademicCredentialCreateRequest
{
    public 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 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 authorizing_uuid: string;

    public constructor(init?: Partial<StudentAcademicCredentialCreateRequest>) { (Object as any).assign(this, init); }
}

export class StudentTransferCredentialPackageCreateRequest
{
    public uuid: string;
    public institution_id: number;
    public authorizing_uuid: string;
    public is_advanced_standing: boolean;
    public studentTransferCredentialCreateRequest: StudentTransferCredentialCreateRequest[];
    public studentAcademicCredentialCreateRequest: StudentAcademicCredentialCreateRequest[];

    public constructor(init?: Partial<StudentTransferCredentialPackageCreateRequest>) { (Object as any).assign(this, init); }
}

TypeScript StudentTransferCredentialPackageCreateRequest 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}/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	institution_id: 0,
	authorizing_uuid: String,
	is_advanced_standing: False,
	studentTransferCredentialCreateRequest: 
	[
		{
			uuid: String,
			course_name: String,
			title: String,
			credit_value: 0,
			authorizing_uuid: String
		}
	],
	studentAcademicCredentialCreateRequest: 
	[
		{
			uuid: String,
			section_id: 0,
			course_name: String,
			section_code: String,
			subject: String,
			course_level: 0,
			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,
			authorizing_uuid: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}