regis

<back to all web services

RecentRegistrationRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/registration/recent
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PersonSimpleResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val ubc_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val uuid:String = null with get,set
        member val regent_login:String = null with get,set
        member val first_name:String = null with get,set
        member val preferred_name:String = null with get,set
        member val middle_name:String = null with get,set
        member val last_name:String = null with get,set
        member val email:String = null with get,set
        member val phone_home:String = null with get,set
        member val phone_cell:String = null with get,set
        member val phone_bus:String = null with get,set
        member val addr1:String = null with get,set
        member val addr2:String = null with get,set
        member val city:String = null with get,set
        member val state:String = null with get,set
        member val country:String = null with get,set
        member val code:String = null with get,set
        member val citizenship:String = null with get,set
        member val citizenship_other:String = null with get,set
        member val permanent_resident:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val is_student:Boolean = new Boolean() with get,set
        member val is_faculty:Boolean = new Boolean() with get,set
        member val is_vendor:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type StudentAcademicCredentialSimpleResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val course_uuid:String = null with get,set
        member val course_name:String = null with get,set
        member val section_code:String = null with get,set
        member val section_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val term:String = null with get,set
        member val reporting_term:String = null with get,set
        member val title:String = null with get,set
        member val amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val is_pass_fail:Boolean = new Boolean() with get,set
        member val is_graded:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type StudentAcademicCredentialByReportingTermSimpleResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val reportingTerm:String = null with get,set
        member val OnlineCreditsAttempted:Decimal = new Decimal() with get,set
        member val OnlineAuditsAttempted:Decimal = new Decimal() with get,set
        member val studentAcademicCredentialSimpleResponse:ResizeArray<StudentAcademicCredentialSimpleResponse> = new ResizeArray<StudentAcademicCredentialSimpleResponse>() with get,set

    [<AllowNullLiteral>]
    type RegistrationDocumentResponse() = 
        member val uuid:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val gender:String = null with get,set
        member val email:String = null with get,set
        member val program:String = null with get,set
        member val concentration:String = null with get,set
        member val section_uuid:String = null with get,set
        member val course_name:String = null with get,set
        member val course_title:String = null with get,set
        member val reporting_term:String = null with get,set
        member val document_code:String = null with get,set
        member val document_json:String = null with get,set
        member val document_name:String = null with get,set
        member val document_description:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ProvisionalRegistrationResponse() = 
        member val uuid:String = null with get,set
        member val regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val student_name:String = null with get,set
        member val email:String = null with get,set
        member val section_uuid:String = null with get,set
        member val student_section_uuid:String = null with get,set
        member val course_name:String = null with get,set
        member val section_code:String = null with get,set
        member val title:String = null with get,set
        member val term:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val is_waitlist:Boolean = new Boolean() with get,set
        member val is_missing_requisites:Boolean = new Boolean() with get,set
        member val is_other_restriction:Boolean = new Boolean() with get,set
        member val documents:ResizeArray<RegistrationDocumentResponse> = new ResizeArray<RegistrationDocumentResponse>() with get,set
        member val requested_date:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ProvisionalRegistrationsForStudentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val provisional_registrations:ResizeArray<ProvisionalRegistrationResponse> = new ResizeArray<ProvisionalRegistrationResponse>() with get,set

    [<AllowNullLiteral>]
    type RegistrationSummaryResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val is_missing_tax_number:Boolean = new Boolean() with get,set
        member val person:PersonSimpleResponse = null with get,set
        member val registrations:ResizeArray<StudentAcademicCredentialByReportingTermSimpleResponse> = new ResizeArray<StudentAcademicCredentialByReportingTermSimpleResponse>() with get,set
        member val provisional_registrations:ProvisionalRegistrationsForStudentResponse = null with get,set

    [<AllowNullLiteral>]
    type RecentRegistrationRequest() = 
        member val uuid:String = null with get,set
        member val from_this_term:String = null with get,set

F# RecentRegistrationRequest 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/recent HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	from_this_term: 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,
	is_missing_tax_number: False,
	person: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		regent_id: 0,
		ubc_id: 0,
		uuid: String,
		regent_login: String,
		first_name: String,
		preferred_name: String,
		middle_name: String,
		last_name: String,
		email: String,
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		addr1: String,
		addr2: String,
		city: String,
		state: String,
		country: String,
		code: String,
		citizenship: String,
		citizenship_other: String,
		permanent_resident: String,
		dob: 0001-01-01,
		is_student: False,
		is_faculty: False,
		is_vendor: False
	},
	registrations: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			reportingTerm: String,
			onlineCreditsAttempted: 0,
			onlineAuditsAttempted: 0,
			studentAcademicCredentialSimpleResponse: 
			[
				{
					responseStatus: 
					{
						errorCode: String,
						message: String,
						stackTrace: String,
						errors: 
						[
							{
								errorCode: String,
								fieldName: String,
								message: String,
								meta: 
								{
									String: String
								}
							}
						],
						meta: 
						{
							String: String
						}
					},
					course_uuid: String,
					course_name: String,
					section_code: String,
					section_id: 0,
					term: String,
					reporting_term: String,
					title: String,
					amount: 0,
					is_audit: False,
					is_pass_fail: False,
					is_graded: False
				}
			]
		}
	],
	provisional_registrations: 
	{
		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
			}
		]
	}
}