regis

<back to all web services

SectionsAdminRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/Admin/{reporting_term}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class SectionsAdminRequest
{
    var reporting_term:String? = null
}

open class SectionsAdminResponse
{
    var responseStatus:ResponseStatus? = null
    var reporting_term:String? = null
    var sections:ArrayList<SectionAdminResponse> = ArrayList<SectionAdminResponse>()
    var section_rates:HashMap<Int,ArrayList<SectionRateWithAmountResponse>> = HashMap<Int,ArrayList<SectionRateWithAmountResponse>>()
    var section_refund_schedules:HashMap<Int,ArrayList<SectionRefundScheduleResponse>> = HashMap<Int,ArrayList<SectionRefundScheduleResponse>>()
    var locations:ArrayList<String> = ArrayList<String>()
    var section_instructors:HashMap<Int,ArrayList<InstructorResponse>> = HashMap<Int,ArrayList<InstructorResponse>>()
    var section_document_codes:HashMap<Int,ArrayList<String>> = HashMap<Int,ArrayList<String>>()
    var crosslisted_sections:HashMap<Int,ArrayList<Int>> = HashMap<Int,ArrayList<Int>>()
}

open class SectionAdminResponse
{
    var uuid:String? = null
    var section_id:Int? = null
    var course_id:Int? = null
    var course_name:String? = null
    var min_credits:BigDecimal? = null
    var max_credits:BigDecimal? = null
    var credit_increments:BigDecimal? = null
    var min_audits:BigDecimal? = null
    var max_audits:BigDecimal? = null
    var audit_increments:BigDecimal? = null
    var section_code:String? = null
    var title:String? = null
    var pretty_title:String? = null
    var override_course_description:String? = null
    var current_status:String? = null
    var location:String? = null
    var room:String? = null
    var is_audio:Boolean? = null
    var is_oncampus:Boolean? = null
    var distance_ed_materials:String? = null
    var start_date:Date? = null
    var end_date:Date? = null
    var first_meeting_date:Date? = null
    var last_meeting_date:Date? = null
    var meeting_days:String? = null
    var start_times:String? = null
    var end_times:String? = null
    var is_pass_fail:Boolean? = null
    var is_weekend:Boolean? = null
    var is_weekday:Boolean? = null
    var is_evening:Boolean? = null
    var is_waitlist:Boolean? = null
    var has_special_requirements:Boolean? = null
    var special_requirements:String? = null
    var is_unlisted:Boolean? = null
    var capacity:Int? = null
    var flat_fee_amount:BigDecimal? = null
    var additional_fee_amount:BigDecimal? = null
    var override_registration_start_date:Date? = null
    var override_registration_end_date:Date? = null
    var override_add_start_date:Date? = null
    var override_add_end_date:Date? = null
    var override_drop_start_date:Date? = null
    var override_drop_end_date:Date? = null
    var override_grading_end_date:Date? = null
    var term:String? = null
    var reporting_term:String? = null
    var reporting_year:Int? = null
    var added_date:Date? = null
    var added_by:String? = null
    var changed_date:Date? = null
    var changed_by:String? = null
    var timestamp:Date? = null
}

Kotlin 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
		]
	}
}