regis

<back to all web services

SectionAvailableToChangeForStudentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/AvailableToChange/{uuid}/Term/{reporting_term}/Section/{secUUID}
SectionAvailableToChangeForStudentRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
secUUIDpathstringNo
reporting_termpathstringNo
SectionAvailableForStudentResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
studentSectionUUIDformstringNo
registered_amountformdecimal?No
is_fullformboolNo
is_too_lateformboolNo
is_too_earlyformboolNo
is_auditformboolNo
is_selectedformboolNo
is_registeredformboolNo
is_provisionalformboolNo
is_missing_requisitesformboolNo
is_completedformboolNo
maximum_credit_hoursformdecimal?No
maximum_audit_hoursformdecimal?No
can_retakeformboolNo
is_credit_restrictedformboolNo
is_audit_restrictedformboolNo
is_oncampus_restricted_for_changeformboolNo
is_online_restricted_for_changeformboolNo
can_be_provisionalformboolNo
can_be_droppedformboolNo
ruleMessagesformList<string>No
SectionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
secUUIDformstringNo
course_nameformstringNo
section_codeformstringNo
course_titleformstringNo
course_short_titleformstringNo
course_descriptionformstringNo
crosslist_descriptionformstringNo
crosslist_course_nameformstringNo
location_long_nameformstringNo
roomformstringNo
instructorsformList<InstructorResponse>No
required_documentsformList<DocumentResponse>No
start_dateformDateTime?No
end_dateformDateTime?No
first_meeting_dateformDateTime?No
last_meeting_dateformDateTime?No
meeting_daysformstringNo
start_timesformList<string>No
end_timesformList<string>No
is_online_onlyformboolNo
is_weekendformboolNo
is_weekdayformboolNo
is_eveningformboolNo
is_waitlistformboolNo
has_special_requirementsformboolNo
special_requirementsformstringNo
is_unlistedformboolNo
credit_amountsformList<decimal>No
audit_amountsformList<decimal>No
audits_short_nameformstringNo
audits_long_nameformstringNo
credits_short_nameformstringNo
credits_long_nameformstringNo
distance_ed_materialsformstringNo
prerequisitesformstringNo
corequisitesformstringNo
capacityformint?No
flat_fee_amountformdecimal?No
additional_fee_amountformdecimal?No
registered_studentsformintNo
three_credit_plusformintNo
two_creditformintNo
one_creditformintNo
three_audit_plusformintNo
two_auditformintNo
one_auditformintNo
crosslist_registered_studentsformintNo
grades_receivedformintNo
crosslist_grades_receivedformintNo
registration_start_dateformDateTime?No
registration_end_dateformDateTime?No
add_start_dateformDateTime?No
add_end_dateformDateTime?No
drop_start_dateformDateTime?No
drop_end_dateformDateTime?No
grading_end_dateformDateTime?No
termformstringNo
reporting_termformstringNo
reporting_yearformintNo
current_statusformstringNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
timestampformDateTimeNo
InstructorResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
regent_loginformstringNo
preferred_nameformstringNo
first_nameformstringNo
last_nameformstringNo
full_nameformstringNo
emailformstringNo
image_base64formstringNo
DocumentResponse Parameters:
NameParameterData TypeRequiredDescription
codeformstringNo
document_nameformstringNo
document_descriptionformstringNo

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

{
	uuid: String,
	secUUID: String,
	reporting_term: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
}