regis

SectionsAdminRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Sections/Admin/{reporting_term}

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 SectionsAdminRequest
            Public Overridable Property reporting_term As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class SectionAdminResponse
            Public Overridable Property uuid As String
            Public Overridable Property section_id As Integer
            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 meeting_days As String
            Public Overridable Property start_times As String
            Public Overridable Property end_times As String
            Public Overridable Property is_pass_fail 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 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 reporting_year As Integer
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property timestamp As Date
        End Class

        Public Partial Class SectionsAdminResponse
            Public Sub New()
                sections = New List(Of SectionAdminResponse)
                section_rates = New Dictionary(Of Integer, List(Of SectionRateWithAmountResponse))
                section_refund_schedules = New Dictionary(Of Integer, List(Of SectionRefundScheduleResponse))
                locations = New List(Of String)
                section_instructors = New Dictionary(Of Integer, List(Of InstructorResponse))
                section_document_codes = New Dictionary(Of Integer, List(Of String))
                crosslisted_sections = New Dictionary(Of Integer, List(Of Int32))
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property reporting_term As String
            Public Overridable Property sections As List(Of SectionAdminResponse)
            Public Overridable Property section_rates As Dictionary(Of Integer, List(Of SectionRateWithAmountResponse))
            Public Overridable Property section_refund_schedules As Dictionary(Of Integer, List(Of SectionRefundScheduleResponse))
            Public Overridable Property locations As List(Of String)
            Public Overridable Property section_instructors As Dictionary(Of Integer, List(Of InstructorResponse))
            Public Overridable Property section_document_codes As Dictionary(Of Integer, List(Of String))
            Public Overridable Property crosslisted_sections As Dictionary(Of Integer, List(Of Int32))
        End Class
    End Namespace
End Namespace

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

{
	reporting_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
		}
	},
	reporting_term: String,
	sections: 
	[
		{
			uuid: String,
			section_id: 0,
			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,
			meeting_days: String,
			start_times: String,
			end_times: String,
			is_pass_fail: False,
			is_weekend: False,
			is_weekday: False,
			is_evening: 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,
			reporting_year: 0,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	],
	section_rates: 
	{
		0: 
		[
			{
				rate_id: 0,
				charge: 0,
				credit: 0,
				responseStatus: 
				{
					errorCode: String,
					message: String,
					stackTrace: String,
					errors: 
					[
						{
							errorCode: String,
							fieldName: String,
							message: String,
							meta: 
							{
								String: String
							}
						}
					],
					meta: 
					{
						String: String
					}
				},
				uuid: String,
				secUUID: String,
				section_id: 0,
				course_name: String,
				section_code: String,
				title: String,
				reporting_term: String,
				rate_code: String,
				rate_description: String,
				is_override_credit_rate: False,
				is_override_audit_rate: False
			}
		]
	},
	section_refund_schedules: 
	{
		0: 
		[
			{
				responseStatus: 
				{
					errorCode: String,
					message: String,
					stackTrace: String,
					errors: 
					[
						{
							errorCode: String,
							fieldName: String,
							message: String,
							meta: 
							{
								String: String
							}
						}
					],
					meta: 
					{
						String: String
					}
				},
				uuid: String,
				secUUID: String,
				section_id: 0,
				course_name: String,
				section_code: String,
				title: String,
				reporting_term: String,
				rate_code: String,
				rate_description: String,
				percentage: 0,
				start_date: 0001-01-01,
				end_date: 0001-01-01
			}
		]
	},
	locations: 
	[
		String
	],
	section_instructors: 
	{
		0: 
		[
			{
				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
			}
		]
	},
	section_document_codes: 
	{
		0: 
		[
			String
		]
	},
	crosslisted_sections: 
	{
		0: 
		[
			0
		]
	}
}