regis

RegentDegreesRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Academic/{uuid}/RegentDegrees

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 RegentDegreeResponse:
    id: int = 0
    program_code: Optional[str] = None
    program_name: Optional[str] = None
    concentration_code: Optional[str] = None
    concentration_name: Optional[str] = None
    graduation_month: Optional[datetime.datetime] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    gpa: Optional[Decimal] = None
    academic_level: Optional[str] = None
    commencement_date: Optional[datetime.datetime] = None
    added_date: Optional[datetime.datetime] = None
    added_by: Optional[str] = None
    changed_date: Optional[datetime.datetime] = None
    changed_by: Optional[str] = None
    timestamp: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProgramResponse:
    response_status: Optional[ResponseStatus] = None
    id: int = 0
    program_code: Optional[str] = None
    program_pretty_code: Optional[str] = None
    program_long_name: Optional[str] = None
    available_concentrations: Optional[str] = None
    is_active: bool = False
    timestamp: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConcentrationResponse:
    response_status: Optional[ResponseStatus] = None
    id: int = 0
    concentration_code: Optional[str] = None
    concentration_name: Optional[str] = None
    is_active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CatalogResponse:
    response_status: Optional[ResponseStatus] = None
    id: int = 0
    catalog_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegentDegreesResponse:
    response_status: Optional[ResponseStatus] = None
    regent_id: int = 0
    uuid: Optional[str] = None
    regent_degrees: Optional[List[RegentDegreeResponse]] = None
    valid_programs: Optional[List[ProgramResponse]] = None
    valid_concentrations: Optional[List[ConcentrationResponse]] = None
    valid_catalogs: Optional[List[CatalogResponse]] = None


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

Python RegentDegreesRequest 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 /Academic/{uuid}/RegentDegrees 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,
	regent_degrees: 
	[
		{
			id: 0,
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			graduation_month: 0001-01-01,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			gpa: 0,
			academic_level: String,
			commencement_date: 0001-01-01,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	],
	valid_programs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			program_code: String,
			program_pretty_code: String,
			program_long_name: String,
			available_concentrations: String,
			is_active: False,
			timestamp: 0001-01-01
		}
	],
	valid_concentrations: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			concentration_code: String,
			concentration_name: String,
			is_active: False
		}
	],
	valid_catalogs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			catalog_code: String
		}
	]
}