regis

<back to all web services

ProvisionalRegistrationsForStudentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Provisional
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 RegistrationDocumentResponse:
    uuid: Optional[str] = None
    regent_id: int = 0
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    gender: Optional[str] = None
    email: Optional[str] = None
    program: Optional[str] = None
    concentration: Optional[str] = None
    section_uuid: Optional[str] = None
    course_name: Optional[str] = None
    course_title: Optional[str] = None
    reporting_term: Optional[str] = None
    document_code: Optional[str] = None
    document_json: Optional[str] = None
    document_name: Optional[str] = None
    document_description: Optional[str] = None
    added_date: Optional[datetime.datetime] = None
    changed_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProvisionalRegistrationResponse:
    uuid: Optional[str] = None
    regent_id: Optional[int] = None
    student_name: Optional[str] = None
    email: Optional[str] = None
    section_uuid: Optional[str] = None
    student_section_uuid: Optional[str] = None
    course_name: Optional[str] = None
    section_code: Optional[str] = None
    title: Optional[str] = None
    term: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    is_audit: bool = False
    is_waitlist: bool = False
    is_missing_requisites: bool = False
    is_other_restriction: bool = False
    documents: Optional[List[RegistrationDocumentResponse]] = None
    requested_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProvisionalRegistrationsForStudentResponse:
    response_status: Optional[ResponseStatus] = None
    regent_id: int = 0
    uuid: Optional[str] = None
    provisional_registrations: Optional[List[ProvisionalRegistrationResponse]] = None


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

Python ProvisionalRegistrationsForStudentRequest 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 /Registration/{uuid}/Provisional 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,
	provisional_registrations: 
	[
		{
			uuid: String,
			regent_id: 0,
			student_name: String,
			email: String,
			section_uuid: String,
			student_section_uuid: String,
			course_name: String,
			section_code: String,
			title: String,
			term: String,
			amount: 0,
			is_audit: False,
			is_waitlist: False,
			is_missing_requisites: False,
			is_other_restriction: False,
			documents: 
			[
				{
					uuid: String,
					regent_id: 0,
					first_name: String,
					last_name: String,
					gender: String,
					email: String,
					program: String,
					concentration: String,
					section_uuid: String,
					course_name: String,
					course_title: String,
					reporting_term: String,
					document_code: String,
					document_json: String,
					document_name: String,
					document_description: String,
					added_date: 0001-01-01,
					changed_date: 0001-01-01
				}
			],
			requested_date: 0001-01-01
		}
	]
}