regis

ShareMyGradesReportRequest

**Requires Authentication**
Required permission:	ShareGrades

The following routes are available for this service:
POST	/ShareMyGrades/Report/{token}

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class StudentAcademicCredentialResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $stac_uuid=null,
        /** @var int|null */
        public ?int $section_id=null,
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $section_code=null,
        /** @var string|null */
        public ?string $subject=null,
        /** @var int|null */
        public ?int $course_level=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var string|null */
        public ?string $pretty_title=null,
        /** @var string|null */
        public ?string $location=null,
        /** @var bool|null */
        public ?bool $is_audio=null,
        /** @var bool|null */
        public ?bool $is_oncampus=null,
        /** @var float|null */
        public ?float $credit_value=null,
        /** @var float|null */
        public ?float $audit_value=null,
        /** @var bool|null */
        public ?bool $is_audit=null,
        /** @var bool|null */
        public ?bool $is_pass_fail=null,
        /** @var string|null */
        public ?string $grade=null,
        /** @var bool|null */
        public ?bool $is_grade_final=null,
        /** @var float|null */
        public ?float $gpa_credits=null,
        /** @var float|null */
        public ?float $grade_points=null,
        /** @var string|null */
        public ?string $academic_level=null,
        /** @var string|null */
        public ?string $printed_comments=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var int|null */
        public ?int $reporting_year=null,
        /** @var string|null */
        public ?string $current_status=null,
        /** @var string|null */
        public ?string $added_by=null,
        /** @var DateTime|null */
        public ?DateTime $added_date=null,
        /** @var string|null */
        public ?string $changed_by=null,
        /** @var DateTime|null */
        public ?DateTime $changed_date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['stac_uuid'])) $this->stac_uuid = $o['stac_uuid'];
        if (isset($o['section_id'])) $this->section_id = $o['section_id'];
        if (isset($o['course_name'])) $this->course_name = $o['course_name'];
        if (isset($o['section_code'])) $this->section_code = $o['section_code'];
        if (isset($o['subject'])) $this->subject = $o['subject'];
        if (isset($o['course_level'])) $this->course_level = $o['course_level'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['pretty_title'])) $this->pretty_title = $o['pretty_title'];
        if (isset($o['location'])) $this->location = $o['location'];
        if (isset($o['is_audio'])) $this->is_audio = $o['is_audio'];
        if (isset($o['is_oncampus'])) $this->is_oncampus = $o['is_oncampus'];
        if (isset($o['credit_value'])) $this->credit_value = $o['credit_value'];
        if (isset($o['audit_value'])) $this->audit_value = $o['audit_value'];
        if (isset($o['is_audit'])) $this->is_audit = $o['is_audit'];
        if (isset($o['is_pass_fail'])) $this->is_pass_fail = $o['is_pass_fail'];
        if (isset($o['grade'])) $this->grade = $o['grade'];
        if (isset($o['is_grade_final'])) $this->is_grade_final = $o['is_grade_final'];
        if (isset($o['gpa_credits'])) $this->gpa_credits = $o['gpa_credits'];
        if (isset($o['grade_points'])) $this->grade_points = $o['grade_points'];
        if (isset($o['academic_level'])) $this->academic_level = $o['academic_level'];
        if (isset($o['printed_comments'])) $this->printed_comments = $o['printed_comments'];
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['reporting_year'])) $this->reporting_year = $o['reporting_year'];
        if (isset($o['current_status'])) $this->current_status = $o['current_status'];
        if (isset($o['added_by'])) $this->added_by = $o['added_by'];
        if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
        if (isset($o['changed_by'])) $this->changed_by = $o['changed_by'];
        if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->stac_uuid)) $o['stac_uuid'] = $this->stac_uuid;
        if (isset($this->section_id)) $o['section_id'] = $this->section_id;
        if (isset($this->course_name)) $o['course_name'] = $this->course_name;
        if (isset($this->section_code)) $o['section_code'] = $this->section_code;
        if (isset($this->subject)) $o['subject'] = $this->subject;
        if (isset($this->course_level)) $o['course_level'] = $this->course_level;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->pretty_title)) $o['pretty_title'] = $this->pretty_title;
        if (isset($this->location)) $o['location'] = $this->location;
        if (isset($this->is_audio)) $o['is_audio'] = $this->is_audio;
        if (isset($this->is_oncampus)) $o['is_oncampus'] = $this->is_oncampus;
        if (isset($this->credit_value)) $o['credit_value'] = $this->credit_value;
        if (isset($this->audit_value)) $o['audit_value'] = $this->audit_value;
        if (isset($this->is_audit)) $o['is_audit'] = $this->is_audit;
        if (isset($this->is_pass_fail)) $o['is_pass_fail'] = $this->is_pass_fail;
        if (isset($this->grade)) $o['grade'] = $this->grade;
        if (isset($this->is_grade_final)) $o['is_grade_final'] = $this->is_grade_final;
        if (isset($this->gpa_credits)) $o['gpa_credits'] = $this->gpa_credits;
        if (isset($this->grade_points)) $o['grade_points'] = $this->grade_points;
        if (isset($this->academic_level)) $o['academic_level'] = $this->academic_level;
        if (isset($this->printed_comments)) $o['printed_comments'] = $this->printed_comments;
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->reporting_year)) $o['reporting_year'] = $this->reporting_year;
        if (isset($this->current_status)) $o['current_status'] = $this->current_status;
        if (isset($this->added_by)) $o['added_by'] = $this->added_by;
        if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
        if (isset($this->changed_by)) $o['changed_by'] = $this->changed_by;
        if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
        return empty($o) ? new class(){} : $o;
    }
}

class StudentAcademicCredentialTranscriptResponse extends StudentAcademicCredentialResponse implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     * @param string|null $uuid
     * @param string|null $stac_uuid
     * @param int|null $section_id
     * @param string|null $course_name
     * @param string|null $section_code
     * @param string|null $subject
     * @param int|null $course_level
     * @param string|null $title
     * @param string|null $pretty_title
     * @param string|null $location
     * @param bool|null $is_audio
     * @param bool|null $is_oncampus
     * @param float|null $credit_value
     * @param float|null $audit_value
     * @param bool|null $is_audit
     * @param bool|null $is_pass_fail
     * @param string|null $grade
     * @param bool|null $is_grade_final
     * @param float|null $gpa_credits
     * @param float|null $grade_points
     * @param string|null $academic_level
     * @param string|null $printed_comments
     * @param string|null $term
     * @param string|null $reporting_term
     * @param int|null $reporting_year
     * @param string|null $current_status
     * @param string|null $added_by
     * @param DateTime|null $added_date
     * @param string|null $changed_by
     * @param DateTime|null $changed_date
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null,
        ?string $uuid=null,
        ?string $stac_uuid=null,
        ?int $section_id=null,
        ?string $course_name=null,
        ?string $section_code=null,
        ?string $subject=null,
        ?int $course_level=null,
        ?string $title=null,
        ?string $pretty_title=null,
        ?string $location=null,
        ?bool $is_audio=null,
        ?bool $is_oncampus=null,
        ?float $credit_value=null,
        ?float $audit_value=null,
        ?bool $is_audit=null,
        ?bool $is_pass_fail=null,
        ?string $grade=null,
        ?bool $is_grade_final=null,
        ?float $gpa_credits=null,
        ?float $grade_points=null,
        ?string $academic_level=null,
        ?string $printed_comments=null,
        ?string $term=null,
        ?string $reporting_term=null,
        ?int $reporting_year=null,
        ?string $current_status=null,
        ?string $added_by=null,
        ?DateTime $added_date=null,
        ?string $changed_by=null,
        ?DateTime $changed_date=null,
        /** @var float|null */
        public ?float $registered_credits=null
    ) {
        parent::__construct($responseStatus,$uuid,$stac_uuid,$section_id,$course_name,$section_code,$subject,$course_level,$title,$pretty_title,$location,$is_audio,$is_oncampus,$credit_value,$audit_value,$is_audit,$is_pass_fail,$grade,$is_grade_final,$gpa_credits,$grade_points,$academic_level,$printed_comments,$term,$reporting_term,$reporting_year,$current_status,$added_by,$added_date,$changed_by,$changed_date);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['registered_credits'])) $this->registered_credits = $o['registered_credits'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->registered_credits)) $o['registered_credits'] = $this->registered_credits;
        return empty($o) ? new class(){} : $o;
    }
}

class StudentTransferCredentialTranscriptResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var bool|null */
        public ?bool $is_advanced_standing=null,
        /** @var float|null */
        public ?float $credit_value=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['course_name'])) $this->course_name = $o['course_name'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['is_advanced_standing'])) $this->is_advanced_standing = $o['is_advanced_standing'];
        if (isset($o['credit_value'])) $this->credit_value = $o['credit_value'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->course_name)) $o['course_name'] = $this->course_name;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->is_advanced_standing)) $o['is_advanced_standing'] = $this->is_advanced_standing;
        if (isset($this->credit_value)) $o['credit_value'] = $this->credit_value;
        return empty($o) ? new class(){} : $o;
    }
}

class ShareMyGradesReportResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $first_name=null,
        /** @var string|null */
        public ?string $last_name=null,
        /** @var int */
        public int $regent_id=0,
        /** @var float */
        public float $gpa=0.0,
        /** @var string|null */
        public ?string $current_program=null,
        /** @var array<StudentAcademicCredentialTranscriptResponse>|null */
        public ?array $student_academic_credentials=null,
        /** @var array<StudentTransferCredentialTranscriptResponse>|null */
        public ?array $transfer_credentials=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['first_name'])) $this->first_name = $o['first_name'];
        if (isset($o['last_name'])) $this->last_name = $o['last_name'];
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['gpa'])) $this->gpa = $o['gpa'];
        if (isset($o['current_program'])) $this->current_program = $o['current_program'];
        if (isset($o['student_academic_credentials'])) $this->student_academic_credentials = JsonConverters::fromArray('StudentAcademicCredentialTranscriptResponse', $o['student_academic_credentials']);
        if (isset($o['transfer_credentials'])) $this->transfer_credentials = JsonConverters::fromArray('StudentTransferCredentialTranscriptResponse', $o['transfer_credentials']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->first_name)) $o['first_name'] = $this->first_name;
        if (isset($this->last_name)) $o['last_name'] = $this->last_name;
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->gpa)) $o['gpa'] = $this->gpa;
        if (isset($this->current_program)) $o['current_program'] = $this->current_program;
        if (isset($this->student_academic_credentials)) $o['student_academic_credentials'] = JsonConverters::toArray('StudentAcademicCredentialTranscriptResponse', $this->student_academic_credentials);
        if (isset($this->transfer_credentials)) $o['transfer_credentials'] = JsonConverters::toArray('StudentTransferCredentialTranscriptResponse', $this->transfer_credentials);
        return empty($o) ? new class(){} : $o;
    }
}

class ShareMyGradesReportRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $token=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['token'])) $this->token = $o['token'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->token)) $o['token'] = $this->token;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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
		}
	]
}