regis

<back to all web services

ShareMyGradesReportRequest

Requires Authentication
Required permission:ShareGrades
The following routes are available for this service:
POST/ShareMyGrades/Report/{token}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class ShareMyGradesReportRequest
{
    var token:String? = null
}

open class ShareMyGradesReportResponse
{
    var responseStatus:ResponseStatus? = null
    var first_name:String? = null
    var last_name:String? = null
    var regent_id:Int? = null
    var gpa:BigDecimal? = null
    var current_program:String? = null
    var student_academic_credentials:ArrayList<StudentAcademicCredentialTranscriptResponse> = ArrayList<StudentAcademicCredentialTranscriptResponse>()
    var transfer_credentials:ArrayList<StudentTransferCredentialTranscriptResponse> = ArrayList<StudentTransferCredentialTranscriptResponse>()
}

open class StudentAcademicCredentialTranscriptResponse : StudentAcademicCredentialResponse()
{
    var registered_credits:BigDecimal? = null
}

open class StudentAcademicCredentialResponse
{
    var responseStatus:ResponseStatus? = null
    var uuid:String? = null
    var stac_uuid:String? = null
    var section_id:Int? = null
    var course_name:String? = null
    var section_code:String? = null
    var subject:String? = null
    var course_level:Int? = null
    var title:String? = null
    var pretty_title:String? = null
    var location:String? = null
    var is_audio:Boolean? = null
    var is_oncampus:Boolean? = null
    var credit_value:BigDecimal? = null
    var audit_value:BigDecimal? = null
    var is_audit:Boolean? = null
    var is_pass_fail:Boolean? = null
    var grade:String? = null
    var is_grade_final:Boolean? = null
    var gpa_credits:BigDecimal? = null
    var grade_points:BigDecimal? = null
    var academic_level:String? = null
    var printed_comments:String? = null
    var term:String? = null
    var reporting_term:String? = null
    var reporting_year:Int? = null
    var current_status:String? = null
    var added_by:String? = null
    var added_date:Date? = null
    var changed_by:String? = null
    var changed_date:Date? = null
}

open class StudentTransferCredentialTranscriptResponse
{
    var course_name:String? = null
    var title:String? = null
    var is_advanced_standing:Boolean? = null
    var credit_value:BigDecimal? = null
}

Kotlin ShareMyGradesReportRequest 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 /ShareMyGrades/Report/{token} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	token: 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
		}
	},
	first_name: String,
	last_name: String,
	regent_id: 0,
	gpa: 0,
	current_program: String,
	student_academic_credentials: 
	[
		{
			registered_credits: 0,
			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
		}
	],
	transfer_credentials: 
	[
		{
			course_name: String,
			title: String,
			is_advanced_standing: False,
			credit_value: 0
		}
	]
}