regis

<back to all web services

SectionCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/Admin/{reporting_term}/Create
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 SectionCreateRequest
            Public Overridable Property course_id As Nullable(Of Integer)
            Public Overridable Property course_name As String
            Public Overridable Property min_credits As Nullable(Of Decimal)
            Public Overridable Property max_credits As Nullable(Of Decimal)
            Public Overridable Property credit_increments As Nullable(Of Decimal)
            Public Overridable Property min_audits As Nullable(Of Decimal)
            Public Overridable Property max_audits As Nullable(Of Decimal)
            Public Overridable Property audit_increments As Nullable(Of Decimal)
            Public Overridable Property section_code As String
            Public Overridable Property title As String
            Public Overridable Property pretty_title As String
            Public Overridable Property override_course_description As String
            Public Overridable Property current_status As String
            Public Overridable Property location As String
            Public Overridable Property room As String
            Public Overridable Property is_audio As Boolean
            Public Overridable Property is_oncampus As Boolean
            Public Overridable Property distance_ed_materials As String
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property first_meeting_date As Nullable(Of Date)
            Public Overridable Property last_meeting_date As Nullable(Of Date)
            Public Overridable Property start_times As String
            Public Overridable Property end_times As String
            Public Overridable Property is_weekday As Boolean
            Public Overridable Property is_weekend As Boolean
            Public Overridable Property is_evening As Boolean
            Public Overridable Property meeting_days As String
            Public Overridable Property is_pass_fail As Boolean
            Public Overridable Property is_waitlist As Boolean
            Public Overridable Property has_special_requirements As Boolean
            Public Overridable Property special_requirements As String
            Public Overridable Property is_unlisted As Boolean
            Public Overridable Property capacity As Nullable(Of Integer)
            Public Overridable Property flat_fee_amount As Nullable(Of Decimal)
            Public Overridable Property additional_fee_amount As Nullable(Of Decimal)
            Public Overridable Property override_registration_start_date As Nullable(Of Date)
            Public Overridable Property override_registration_end_date As Nullable(Of Date)
            Public Overridable Property override_add_start_date As Nullable(Of Date)
            Public Overridable Property override_add_end_date As Nullable(Of Date)
            Public Overridable Property override_drop_start_date As Nullable(Of Date)
            Public Overridable Property override_drop_end_date As Nullable(Of Date)
            Public Overridable Property override_grading_end_date As Nullable(Of Date)
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property authorizing_uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class DocumentResponse
            Public Overridable Property code As String
            Public Overridable Property document_name As String
            Public Overridable Property document_description As String
        End Class

        Public Partial Class InstructorResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property regent_login As String
            Public Overridable Property preferred_name As String
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property full_name As String
            Public Overridable Property email As String
            Public Overridable Property image_base64 As String
        End Class

        Public Partial Class SectionResponse
            Public Sub New()
                instructors = New List(Of InstructorResponse)
                required_documents = New List(Of DocumentResponse)
                start_times = New List(Of String)
                end_times = New List(Of String)
                credit_amounts = New List(Of Decimal)
                audit_amounts = New List(Of Decimal)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property secUUID As String
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property course_title As String
            Public Overridable Property course_short_title As String
            Public Overridable Property course_description As String
            Public Overridable Property crosslist_description As String
            Public Overridable Property crosslist_course_name As String
            Public Overridable Property location_long_name As String
            Public Overridable Property room As String
            Public Overridable Property instructors As List(Of InstructorResponse)
            Public Overridable Property required_documents As List(Of DocumentResponse)
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property first_meeting_date As Nullable(Of Date)
            Public Overridable Property last_meeting_date As Nullable(Of Date)
            Public Overridable Property meeting_days As String
            Public Overridable Property start_times As List(Of String)
            Public Overridable Property end_times As List(Of String)
            Public Overridable Property is_online_only As Boolean
            Public Overridable Property is_weekend As Boolean
            Public Overridable Property is_weekday As Boolean
            Public Overridable Property is_evening As Boolean
            Public Overridable Property is_waitlist As Boolean
            Public Overridable Property has_special_requirements As Boolean
            Public Overridable Property special_requirements As String
            Public Overridable Property is_unlisted As Boolean
            Public Overridable Property credit_amounts As List(Of Decimal)
            Public Overridable Property audit_amounts As List(Of Decimal)
            Public Overridable Property audits_short_name As String
            Public Overridable Property audits_long_name As String
            Public Overridable Property credits_short_name As String
            Public Overridable Property credits_long_name As String
            Public Overridable Property distance_ed_materials As String
            Public Overridable Property prerequisites As String
            Public Overridable Property corequisites As String
            Public Overridable Property capacity As Nullable(Of Integer)
            Public Overridable Property flat_fee_amount As Nullable(Of Decimal)
            Public Overridable Property additional_fee_amount As Nullable(Of Decimal)
            Public Overridable Property registered_students As Integer
            Public Overridable Property three_credit_plus As Integer
            Public Overridable Property two_credit As Integer
            Public Overridable Property one_credit As Integer
            Public Overridable Property three_audit_plus As Integer
            Public Overridable Property two_audit As Integer
            Public Overridable Property one_audit As Integer
            Public Overridable Property crosslist_registered_students As Integer
            Public Overridable Property grades_received As Integer
            Public Overridable Property crosslist_grades_received As Integer
            Public Overridable Property registration_start_date As Nullable(Of Date)
            Public Overridable Property registration_end_date As Nullable(Of Date)
            Public Overridable Property add_start_date As Nullable(Of Date)
            Public Overridable Property add_end_date As Nullable(Of Date)
            Public Overridable Property drop_start_date As Nullable(Of Date)
            Public Overridable Property drop_end_date As Nullable(Of Date)
            Public Overridable Property grading_end_date As Nullable(Of Date)
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_year As Integer
            Public Overridable Property current_status As String
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
            Public Overridable Property timestamp As Date
        End Class
    End Namespace
End Namespace

VB.NET SectionCreateRequest 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 /Sections/Admin/{reporting_term}/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	course_id: 0,
	course_name: String,
	min_credits: 0,
	max_credits: 0,
	credit_increments: 0,
	min_audits: 0,
	max_audits: 0,
	audit_increments: 0,
	section_code: String,
	title: String,
	pretty_title: String,
	override_course_description: String,
	current_status: String,
	location: String,
	room: String,
	is_audio: False,
	is_oncampus: False,
	distance_ed_materials: String,
	start_date: 0001-01-01,
	end_date: 0001-01-01,
	first_meeting_date: 0001-01-01,
	last_meeting_date: 0001-01-01,
	start_times: String,
	end_times: String,
	is_weekday: False,
	is_weekend: False,
	is_evening: False,
	meeting_days: String,
	is_pass_fail: False,
	is_waitlist: False,
	has_special_requirements: False,
	special_requirements: String,
	is_unlisted: False,
	capacity: 0,
	flat_fee_amount: 0,
	additional_fee_amount: 0,
	override_registration_start_date: 0001-01-01,
	override_registration_end_date: 0001-01-01,
	override_add_start_date: 0001-01-01,
	override_add_end_date: 0001-01-01,
	override_drop_start_date: 0001-01-01,
	override_drop_end_date: 0001-01-01,
	override_grading_end_date: 0001-01-01,
	term: String,
	reporting_term: String,
	authorizing_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
		}
	},
	secUUID: String,
	course_name: String,
	section_code: String,
	course_title: String,
	course_short_title: String,
	course_description: String,
	crosslist_description: String,
	crosslist_course_name: String,
	location_long_name: String,
	room: String,
	instructors: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			regent_id: 0,
			regent_login: String,
			preferred_name: String,
			first_name: String,
			last_name: String,
			full_name: String,
			email: String,
			image_base64: String
		}
	],
	required_documents: 
	[
		{
			code: String,
			document_name: String,
			document_description: String
		}
	],
	start_date: 0001-01-01,
	end_date: 0001-01-01,
	first_meeting_date: 0001-01-01,
	last_meeting_date: 0001-01-01,
	meeting_days: String,
	start_times: 
	[
		String
	],
	end_times: 
	[
		String
	],
	is_online_only: False,
	is_weekend: False,
	is_weekday: False,
	is_evening: False,
	is_waitlist: False,
	has_special_requirements: False,
	special_requirements: String,
	is_unlisted: False,
	credit_amounts: 
	[
		0
	],
	audit_amounts: 
	[
		0
	],
	audits_short_name: String,
	audits_long_name: String,
	credits_short_name: String,
	credits_long_name: String,
	distance_ed_materials: String,
	prerequisites: String,
	corequisites: String,
	capacity: 0,
	flat_fee_amount: 0,
	additional_fee_amount: 0,
	registered_students: 0,
	three_credit_plus: 0,
	two_credit: 0,
	one_credit: 0,
	three_audit_plus: 0,
	two_audit: 0,
	one_audit: 0,
	crosslist_registered_students: 0,
	grades_received: 0,
	crosslist_grades_received: 0,
	registration_start_date: 0001-01-01,
	registration_end_date: 0001-01-01,
	add_start_date: 0001-01-01,
	add_end_date: 0001-01-01,
	drop_start_date: 0001-01-01,
	drop_end_date: 0001-01-01,
	grading_end_date: 0001-01-01,
	term: String,
	reporting_term: String,
	reporting_year: 0,
	current_status: String,
	added_by: String,
	added_date: 0001-01-01,
	changed_by: String,
	changed_date: 0001-01-01,
	timestamp: 0001-01-01
}