regis

<back to all web services

StudentAcademicCredentialsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentAcademicCredentials/{uuid}
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 StudentAcademicCredentialsResponse:
    response_status: Optional[ResponseStatus] = None
    regent_id: int = 0
    uuid: Optional[str] = None
    student_academic_credentials: Optional[List[StudentAcademicCredentialResponse]] = None


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

Python StudentAcademicCredentialsRequest 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 /StudentAcademicCredentials/{uuid} 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
		}
	]
}