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}
namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type SectionAdminResponse() = 
        member val uuid:String = null with get,set
        member val section_id:Int32 = new Int32() with get,set
        member val course_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val course_name:String = null with get,set
        member val min_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val max_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val credit_increments:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val min_audits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val max_audits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val audit_increments:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val section_code:String = null with get,set
        member val title:String = null with get,set
        member val pretty_title:String = null with get,set
        member val override_course_description:String = null with get,set
        member val current_status:String = null with get,set
        member val location:String = null with get,set
        member val room:String = null with get,set
        member val is_audio:Boolean = new Boolean() with get,set
        member val is_oncampus:Boolean = new Boolean() with get,set
        member val distance_ed_materials:String = null with get,set
        member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val first_meeting_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val last_meeting_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val meeting_days:String = null with get,set
        member val start_times:String = null with get,set
        member val end_times:String = null with get,set
        member val is_pass_fail:Boolean = new Boolean() with get,set
        member val is_weekend:Boolean = new Boolean() with get,set
        member val is_weekday:Boolean = new Boolean() with get,set
        member val is_evening:Boolean = new Boolean() with get,set
        member val is_waitlist:Boolean = new Boolean() with get,set
        member val has_special_requirements:Boolean = new Boolean() with get,set
        member val special_requirements:String = null with get,set
        member val is_unlisted:Boolean = new Boolean() with get,set
        member val capacity:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val flat_fee_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val additional_fee_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val override_registration_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val override_registration_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val override_add_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val override_add_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val override_drop_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val override_drop_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val override_grading_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val term:String = null with get,set
        member val reporting_term:String = null with get,set
        member val reporting_year:Int32 = new Int32() with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set
        member val timestamp:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type SectionsAdminResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val reporting_term:String = null with get,set
        member val sections:ResizeArray<SectionAdminResponse> = new ResizeArray<SectionAdminResponse>() with get,set
        member val section_rates:Dictionary<Int32, List<SectionRateWithAmountResponse>> = new Dictionary<Int32, List<SectionRateWithAmountResponse>>() with get,set
        member val section_refund_schedules:Dictionary<Int32, List<SectionRefundScheduleResponse>> = new Dictionary<Int32, List<SectionRefundScheduleResponse>>() with get,set
        member val locations:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val section_instructors:Dictionary<Int32, List<InstructorResponse>> = new Dictionary<Int32, List<InstructorResponse>>() with get,set
        member val section_document_codes:Dictionary<Int32, List<String>> = new Dictionary<Int32, List<String>>() with get,set
        member val crosslisted_sections:Dictionary<Int32, List<Int32>> = new Dictionary<Int32, List<Int32>>() with get,set

    [<AllowNullLiteral>]
    type SectionsAdminRequest() = 
        member val reporting_term:String = null with get,set

F# 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
		]
	}
}