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
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type StudentAcademicCredentialResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val uuid:String = null with get,set
        member val stac_uuid:String = null with get,set
        member val section_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val course_name:String = null with get,set
        member val section_code:String = null with get,set
        member val subject:String = null with get,set
        member val course_level:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val title:String = null with get,set
        member val pretty_title:String = null with get,set
        member val location:String = null with get,set
        member val is_audio:Boolean = new Boolean() with get,set
        member val is_oncampus:Boolean = new Boolean() with get,set
        member val credit_value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val audit_value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val is_pass_fail:Boolean = new Boolean() with get,set
        member val grade:String = null with get,set
        member val is_grade_final:Boolean = new Boolean() with get,set
        member val gpa_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val grade_points:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val academic_level:String = null with get,set
        member val printed_comments:String = null with get,set
        member val term:String = null with get,set
        member val reporting_term:String = null with get,set
        member val reporting_year:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val current_status:String = null with get,set
        member val added_by:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type InstructorResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val regent_login:String = null with get,set
        member val preferred_name:String = null with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val full_name:String = null with get,set
        member val email:String = null with get,set
        member val image_base64:String = null with get,set

    [<AllowNullLiteral>]
    type StudentAcademicCredentialExtensionResponse() = 
        member val uuid:String = null with get,set
        member val stac_uuid:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val course_name:String = null with get,set
        member val section_code:String = null with get,set
        member val location_code:String = null with get,set
        member val title:String = null with get,set
        member val term:String = null with get,set
        member val reporting_term:String = null with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val is_active:Boolean = new Boolean() with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val instructors:ResizeArray<InstructorResponse> = new ResizeArray<InstructorResponse>() with get,set
        member val due_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val received_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val grade_penalty:String = null with get,set
        member val assignments:String = null with get,set
        member val comments:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set

    [<AllowNullLiteral>]
    type GradeResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val id:Int32 = new Int32() with get,set
        member val grade_code:String = null with get,set
        member val grade_name:String = null with get,set
        member val grade_points:Decimal = new Decimal() with get,set
        member val gpa_credit:Boolean = new Boolean() with get,set
        member val completed_credit:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GradeByStudentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val studentAcademicCredentials:ResizeArray<StudentAcademicCredentialResponse> = new ResizeArray<StudentAcademicCredentialResponse>() with get,set
        member val studentAcademicCredentialRetakes:ResizeArray<StudentAcademicCredentialResponse> = new ResizeArray<StudentAcademicCredentialResponse>() with get,set
        member val studentAcademicCredentialExtensions:ResizeArray<StudentAcademicCredentialExtensionResponse> = new ResizeArray<StudentAcademicCredentialExtensionResponse>() with get,set
        member val validGrades:ResizeArray<GradeResponse> = new ResizeArray<GradeResponse>() with get,set

    [<AllowNullLiteral>]
    type GradeByStudentRequest() = 
        member val uuid:String = null with get,set

F# 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
		}
	]
}