regis

<back to all web services

StudentGraduationRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentGraduation/{uuid}/{year}
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 StudentGraduationProgramResponse:
    program_code: Optional[str] = None
    concentration_code: Optional[str] = None
    program_details: Optional[str] = None
    comments: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentGraduationResponse:
    response_status: Optional[ResponseStatus] = None
    regent_id: int = 0
    uuid: Optional[str] = None
    first_name: Optional[str] = None
    preferred_name: Optional[str] = None
    middle_name: Optional[str] = None
    last_name: Optional[str] = None
    email: Optional[str] = None
    phonetic_first_name: Optional[str] = None
    phonetic_middle_name: Optional[str] = None
    phonetic_last_name: Optional[str] = None
    placement: Optional[str] = None
    placement_other: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None
    citizenship: Optional[str] = None
    citizenship_other: Optional[str] = None
    permanent_resident: Optional[str] = None
    previous_degrees: Optional[str] = None
    gown_size: Optional[int] = None
    project_title: Optional[str] = None
    supervisor: Optional[str] = None
    is_attending: bool = False
    is_hood_requested: bool = False
    is_hood_paid: bool = False
    is_paid: bool = False
    is_late: bool = False
    year: Optional[int] = None
    comments: Optional[str] = None
    current_status: Optional[str] = None
    current_status_date: Optional[datetime.datetime] = None
    added_date: Optional[datetime.datetime] = None
    applied_programs: Optional[List[StudentGraduationProgramResponse]] = None


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

Python StudentGraduationRequest 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 /StudentGraduation/{uuid}/{year} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	year: 0
}
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,
	first_name: String,
	preferred_name: String,
	middle_name: String,
	last_name: String,
	email: String,
	phonetic_first_name: String,
	phonetic_middle_name: String,
	phonetic_last_name: String,
	placement: String,
	placement_other: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	previous_degrees: String,
	gown_size: 0,
	project_title: String,
	supervisor: String,
	is_attending: False,
	is_hood_requested: False,
	is_hood_paid: False,
	is_paid: False,
	is_late: False,
	year: 0,
	comments: String,
	current_status: String,
	current_status_date: 0001-01-01,
	added_date: 0001-01-01,
	applied_programs: 
	[
		{
			program_code: String,
			concentration_code: String,
			program_details: String,
			comments: String
		}
	]
}