regis

<back to all web services

GradeByStudentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Student/{uuid}/Grade

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 InstructorResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public regent_login: string;
    public preferred_name: string;
    public first_name: string;
    public last_name: string;
    public full_name: string;
    public email: string;
    public image_base64: string;

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

export class StudentAcademicCredentialExtensionResponse
{
    public uuid: string;
    public stac_uuid: string;
    public regent_id: number;
    public first_name: string;
    public last_name: string;
    public course_name: string;
    public section_code: string;
    public location_code: string;
    public title: string;
    public term: string;
    public reporting_term: string;
    public is_audit: boolean;
    public is_active: boolean;
    public amount: number;
    public instructors: InstructorResponse[];
    public due_date?: string;
    public received_date?: string;
    public grade_penalty: string;
    public assignments: string;
    public comments: string;
    public added_date?: string;
    public added_by: string;
    public changed_date?: string;
    public changed_by: string;

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

export class GradeResponse
{
    public responseStatus: ResponseStatus;
    public id: number;
    public grade_code: string;
    public grade_name: string;
    public grade_points: number;
    public gpa_credit: boolean;
    public completed_credit: boolean;

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

export class GradeByStudentResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public studentAcademicCredentials: StudentAcademicCredentialResponse[];
    public studentAcademicCredentialRetakes: StudentAcademicCredentialResponse[];
    public studentAcademicCredentialExtensions: StudentAcademicCredentialExtensionResponse[];
    public validGrades: GradeResponse[];

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

export class GradeByStudentRequest
{
    public uuid: string;

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

TypeScript GradeByStudentRequest 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 /Academic/Student/{uuid}/Grade 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,
	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
		}
	],
	studentAcademicCredentialRetakes: 
	[
		{
			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
		}
	],
	studentAcademicCredentialExtensions: 
	[
		{
			uuid: String,
			stac_uuid: String,
			regent_id: 0,
			first_name: String,
			last_name: String,
			course_name: String,
			section_code: String,
			location_code: String,
			title: String,
			term: String,
			reporting_term: String,
			is_audit: False,
			is_active: False,
			amount: 0,
			instructors: 
			[
				{
					responseStatus: 
					{
						errorCode: String,
						message: String,
						stackTrace: String,
						errors: 
						[
							{
								errorCode: String,
								fieldName: String,
								message: String,
								meta: 
								{
									String: String
								}
							}
						],
						meta: 
						{
							String: String
						}
					},
					regent_id: 0,
					regent_login: String,
					preferred_name: String,
					first_name: String,
					last_name: String,
					full_name: String,
					email: String,
					image_base64: String
				}
			],
			due_date: 0001-01-01,
			received_date: 0001-01-01,
			grade_penalty: String,
			assignments: String,
			comments: String,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String
		}
	],
	validGrades: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			grade_code: String,
			grade_name: String,
			grade_points: 0,
			gpa_credit: False,
			completed_credit: False
		}
	]
}