regis

RegistrationSummaryRequest

**Requires Authentication**
Required permission:	ReadRegistrationAvailability

The following routes are available for this service:
POST	/registration/summary

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class RegistrationSummaryRequest
            Public Overridable Property uuid As String
            Public Overridable Property from_this_term As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class PersonSimpleResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property ubc_id As Nullable(Of Integer)
            Public Overridable Property uuid As String
            Public Overridable Property regent_login As String
            Public Overridable Property first_name As String
            Public Overridable Property preferred_name As String
            Public Overridable Property middle_name As String
            Public Overridable Property last_name As String
            Public Overridable Property email As String
            Public Overridable Property phone_home As String
            Public Overridable Property phone_cell As String
            Public Overridable Property phone_bus As String
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property city As String
            Public Overridable Property state As String
            Public Overridable Property country As String
            Public Overridable Property code As String
            Public Overridable Property citizenship As String
            Public Overridable Property citizenship_other As String
            Public Overridable Property permanent_resident As String
            Public Overridable Property dob As Nullable(Of Date)
            Public Overridable Property is_student As Boolean
            Public Overridable Property is_faculty As Boolean
            Public Overridable Property is_vendor As Boolean
        End Class

        Public Partial Class ProvisionalRegistrationResponse
            Public Sub New()
                documents = New List(Of RegistrationDocumentResponse)
            End Sub

            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Nullable(Of Integer)
            Public Overridable Property student_name As String
            Public Overridable Property email As String
            Public Overridable Property section_uuid As String
            Public Overridable Property student_section_uuid As String
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property title As String
            Public Overridable Property term As String
            Public Overridable Property amount As Decimal
            Public Overridable Property is_audit As Boolean
            Public Overridable Property is_waitlist As Boolean
            Public Overridable Property is_missing_requisites As Boolean
            Public Overridable Property is_other_restriction As Boolean
            Public Overridable Property documents As List(Of RegistrationDocumentResponse)
            Public Overridable Property requested_date As Date
        End Class

        Public Partial Class ProvisionalRegistrationsForStudentResponse
            Public Sub New()
                provisional_registrations = New List(Of ProvisionalRegistrationResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property provisional_registrations As List(Of ProvisionalRegistrationResponse)
        End Class

        Public Partial Class RegistrationDocumentResponse
            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property gender As String
            Public Overridable Property email As String
            Public Overridable Property program As String
            Public Overridable Property concentration As String
            Public Overridable Property section_uuid As String
            Public Overridable Property course_name As String
            Public Overridable Property course_title As String
            Public Overridable Property reporting_term As String
            Public Overridable Property document_code As String
            Public Overridable Property document_json As String
            Public Overridable Property document_name As String
            Public Overridable Property document_description As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class

        Public Partial Class RegistrationSummaryResponse
            Public Sub New()
                registrations = New List(Of StudentAcademicCredentialByReportingTermSimpleResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property is_missing_tax_number As Boolean
            Public Overridable Property person As PersonSimpleResponse
            Public Overridable Property registrations As List(Of StudentAcademicCredentialByReportingTermSimpleResponse)
            Public Overridable Property provisional_registrations As ProvisionalRegistrationsForStudentResponse
        End Class

        Public Partial Class StudentAcademicCredentialByReportingTermSimpleResponse
            Public Sub New()
                studentAcademicCredentialSimpleResponse = New List(Of StudentAcademicCredentialSimpleResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property reportingTerm As String
            Public Overridable Property OnlineCreditsAttempted As Decimal
            Public Overridable Property OnlineAuditsAttempted As Decimal
            Public Overridable Property studentAcademicCredentialSimpleResponse As List(Of StudentAcademicCredentialSimpleResponse)
        End Class

        Public Partial Class StudentAcademicCredentialSimpleResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property course_uuid As String
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property section_id As Nullable(Of Integer)
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property title As String
            Public Overridable Property amount As Nullable(Of Decimal)
            Public Overridable Property is_audit As Boolean
            Public Overridable Property is_pass_fail As Boolean
            Public Overridable Property is_graded As Boolean
        End Class
    End Namespace
End Namespace

VB.NET RegistrationSummaryRequest 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/summary 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
			}
		]
	}
}