regis

<back to all web services

ShareMyGradesReportRequest

Requires Authentication
Required permission:ShareGrades
The following routes are available for this service:
POST/ShareMyGrades/Report/{token}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class ShareMyGradesReportRequest
    {
        public virtual string token { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class ShareMyGradesReportResponse
    {
        public ShareMyGradesReportResponse()
        {
            student_academic_credentials = new List<StudentAcademicCredentialTranscriptResponse>{};
            transfer_credentials = new List<StudentTransferCredentialTranscriptResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual int regent_id { get; set; }
        public virtual decimal gpa { get; set; }
        public virtual string current_program { get; set; }
        public virtual List<StudentAcademicCredentialTranscriptResponse> student_academic_credentials { get; set; }
        public virtual List<StudentTransferCredentialTranscriptResponse> transfer_credentials { get; set; }
    }

    public partial class StudentAcademicCredentialResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string uuid { get; set; }
        public virtual string stac_uuid { get; set; }
        public virtual int? section_id { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual string subject { get; set; }
        public virtual int? course_level { get; set; }
        public virtual string title { get; set; }
        public virtual string pretty_title { get; set; }
        public virtual string location { get; set; }
        public virtual bool is_audio { get; set; }
        public virtual bool is_oncampus { get; set; }
        public virtual decimal? credit_value { get; set; }
        public virtual decimal? audit_value { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual bool is_pass_fail { get; set; }
        public virtual string grade { get; set; }
        public virtual bool is_grade_final { get; set; }
        public virtual decimal? gpa_credits { get; set; }
        public virtual decimal? grade_points { get; set; }
        public virtual string academic_level { get; set; }
        public virtual string printed_comments { get; set; }
        public virtual string term { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual int? reporting_year { get; set; }
        public virtual string current_status { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
    }

    public partial class StudentAcademicCredentialTranscriptResponse
        : StudentAcademicCredentialResponse
    {
        public virtual decimal? registered_credits { get; set; }
    }

    public partial class StudentTransferCredentialTranscriptResponse
    {
        public virtual string course_name { get; set; }
        public virtual string title { get; set; }
        public virtual bool is_advanced_standing { get; set; }
        public virtual decimal? credit_value { get; set; }
    }

}

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