regis

<back to all web services

SectionsAvailableToChangeForStudentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/AvailableToChange/{uuid}/Term/{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 InstructorResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val regent_login:String = null with get,set
        member val preferred_name:String = null with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val full_name:String = null with get,set
        member val email:String = null with get,set
        member val image_base64:String = null with get,set

    [<AllowNullLiteral>]
    type DocumentResponse() = 
        member val code:String = null with get,set
        member val document_name:String = null with get,set
        member val document_description:String = null with get,set

    [<AllowNullLiteral>]
    type SectionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val secUUID:String = null with get,set
        member val course_name:String = null with get,set
        member val section_code:String = null with get,set
        member val course_title:String = null with get,set
        member val course_short_title:String = null with get,set
        member val course_description:String = null with get,set
        member val crosslist_description:String = null with get,set
        member val crosslist_course_name:String = null with get,set
        member val location_long_name:String = null with get,set
        member val room:String = null with get,set
        member val instructors:ResizeArray<InstructorResponse> = new ResizeArray<InstructorResponse>() with get,set
        member val required_documents:ResizeArray<DocumentResponse> = new ResizeArray<DocumentResponse>() 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:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val end_times:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val is_online_only: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 credit_amounts:ResizeArray<Decimal> = new ResizeArray<Decimal>() with get,set
        member val audit_amounts:ResizeArray<Decimal> = new ResizeArray<Decimal>() with get,set
        member val audits_short_name:String = null with get,set
        member val audits_long_name:String = null with get,set
        member val credits_short_name:String = null with get,set
        member val credits_long_name:String = null with get,set
        member val distance_ed_materials:String = null with get,set
        member val prerequisites:String = null with get,set
        member val corequisites:String = null 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 registered_students:Int32 = new Int32() with get,set
        member val three_credit_plus:Int32 = new Int32() with get,set
        member val two_credit:Int32 = new Int32() with get,set
        member val one_credit:Int32 = new Int32() with get,set
        member val three_audit_plus:Int32 = new Int32() with get,set
        member val two_audit:Int32 = new Int32() with get,set
        member val one_audit:Int32 = new Int32() with get,set
        member val crosslist_registered_students:Int32 = new Int32() with get,set
        member val grades_received:Int32 = new Int32() with get,set
        member val crosslist_grades_received:Int32 = new Int32() with get,set
        member val registration_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val registration_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val add_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val add_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val drop_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val drop_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val 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 current_status:String = null with get,set
        member val added_by:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val timestamp:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type SectionAvailableForStudentResponse() = 
        inherit SectionResponse()
        member val uuid:String = null with get,set
        member val studentSectionUUID:String = null with get,set
        member val registered_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val is_full:Boolean = new Boolean() with get,set
        member val is_too_late:Boolean = new Boolean() with get,set
        member val is_too_early:Boolean = new Boolean() with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val is_selected:Boolean = new Boolean() with get,set
        member val is_registered:Boolean = new Boolean() with get,set
        member val is_provisional:Boolean = new Boolean() with get,set
        member val is_missing_requisites:Boolean = new Boolean() with get,set
        member val is_completed:Boolean = new Boolean() with get,set
        member val maximum_credit_hours:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val maximum_audit_hours:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val can_retake:Boolean = new Boolean() with get,set
        member val is_credit_restricted:Boolean = new Boolean() with get,set
        member val is_audit_restricted:Boolean = new Boolean() with get,set
        member val is_oncampus_restricted_for_change:Boolean = new Boolean() with get,set
        member val is_online_restricted_for_change:Boolean = new Boolean() with get,set
        member val can_be_provisional:Boolean = new Boolean() with get,set
        member val can_be_dropped:Boolean = new Boolean() with get,set
        member val ruleMessages:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type SectionsAvailableForStudentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val notifyOfAcademicProbation:Boolean = new Boolean() with get,set
        member val sectionsAvailable:ResizeArray<SectionAvailableForStudentResponse> = new ResizeArray<SectionAvailableForStudentResponse>() with get,set
        member val messages:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type SectionsAvailableToChangeForStudentRequest() = 
        member val uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val online_only:Boolean = new Boolean() with get,set

F# SectionsAvailableToChangeForStudentRequest 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/AvailableToChange/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	reporting_term: String,
	online_only: False
}
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,
	reporting_term: String,
	notifyOfAcademicProbation: False,
	sectionsAvailable: 
	[
		{
			uuid: String,
			studentSectionUUID: String,
			registered_amount: 0,
			is_full: False,
			is_too_late: False,
			is_too_early: False,
			is_audit: False,
			is_selected: False,
			is_registered: False,
			is_provisional: False,
			is_missing_requisites: False,
			is_completed: False,
			maximum_credit_hours: 0,
			maximum_audit_hours: 0,
			can_retake: False,
			is_credit_restricted: False,
			is_audit_restricted: False,
			is_oncampus_restricted_for_change: False,
			is_online_restricted_for_change: False,
			can_be_provisional: False,
			can_be_dropped: False,
			ruleMessages: 
			[
				String
			],
			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
		}
	],
	messages: 
	[
		String
	]
}