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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentAcademicCredentialResponse:
    response_status: Optional[ResponseStatus] = None
    uuid: Optional[str] = None
    stac_uuid: Optional[str] = None
    section_id: Optional[int] = None
    course_name: Optional[str] = None
    section_code: Optional[str] = None
    subject: Optional[str] = None
    course_level: Optional[int] = None
    title: Optional[str] = None
    pretty_title: Optional[str] = None
    location: Optional[str] = None
    is_audio: bool = False
    is_oncampus: bool = False
    credit_value: Optional[Decimal] = None
    audit_value: Optional[Decimal] = None
    is_audit: bool = False
    is_pass_fail: bool = False
    grade: Optional[str] = None
    is_grade_final: bool = False
    gpa_credits: Optional[Decimal] = None
    grade_points: Optional[Decimal] = None
    academic_level: Optional[str] = None
    printed_comments: Optional[str] = None
    term: Optional[str] = None
    reporting_term: Optional[str] = None
    reporting_year: Optional[int] = None
    current_status: Optional[str] = None
    added_by: Optional[str] = None
    added_date: Optional[datetime.datetime] = None
    changed_by: Optional[str] = None
    changed_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentAcademicCredentialTranscriptResponse(StudentAcademicCredentialResponse):
    registered_credits: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentTransferCredentialTranscriptResponse:
    course_name: Optional[str] = None
    title: Optional[str] = None
    is_advanced_standing: bool = False
    credit_value: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShareMyGradesReportResponse:
    response_status: Optional[ResponseStatus] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    regent_id: int = 0
    gpa: Decimal = decimal.Decimal(0)
    current_program: Optional[str] = None
    student_academic_credentials: Optional[List[StudentAcademicCredentialTranscriptResponse]] = None
    transfer_credentials: Optional[List[StudentTransferCredentialTranscriptResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShareMyGradesReportRequest:
    token: Optional[str] = None

Python ShareMyGradesReportRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}],"transfer_credentials":[{"course_name":"String","title":"String","is_advanced_standing":false,"credit_value":0}]}