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}

export class InstructorResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public regent_login: string;
    public preferred_name: string;
    public first_name: string;
    public last_name: string;
    public full_name: string;
    public email: string;
    public image_base64: string;

    public constructor(init?: Partial<InstructorResponse>) { (Object as any).assign(this, init); }
}

export class DocumentResponse
{
    public code: string;
    public document_name: string;
    public document_description: string;

    public constructor(init?: Partial<DocumentResponse>) { (Object as any).assign(this, init); }
}

export class SectionResponse
{
    public responseStatus: ResponseStatus;
    public secUUID: string;
    public course_name: string;
    public section_code: string;
    public course_title: string;
    public course_short_title: string;
    public course_description: string;
    public crosslist_description: string;
    public crosslist_course_name: string;
    public location_long_name: string;
    public room: string;
    public instructors: InstructorResponse[];
    public required_documents: DocumentResponse[];
    public start_date?: string;
    public end_date?: string;
    public first_meeting_date?: string;
    public last_meeting_date?: string;
    public meeting_days: string;
    public start_times: string[];
    public end_times: string[];
    public is_online_only: boolean;
    public is_weekend: boolean;
    public is_weekday: boolean;
    public is_evening: boolean;
    public is_waitlist: boolean;
    public has_special_requirements: boolean;
    public special_requirements: string;
    public is_unlisted: boolean;
    public credit_amounts: number[];
    public audit_amounts: number[];
    public audits_short_name: string;
    public audits_long_name: string;
    public credits_short_name: string;
    public credits_long_name: string;
    public distance_ed_materials: string;
    public prerequisites: string;
    public corequisites: string;
    public capacity?: number;
    public flat_fee_amount?: number;
    public additional_fee_amount?: number;
    public registered_students: number;
    public three_credit_plus: number;
    public two_credit: number;
    public one_credit: number;
    public three_audit_plus: number;
    public two_audit: number;
    public one_audit: number;
    public crosslist_registered_students: number;
    public grades_received: number;
    public crosslist_grades_received: number;
    public registration_start_date?: string;
    public registration_end_date?: string;
    public add_start_date?: string;
    public add_end_date?: string;
    public drop_start_date?: string;
    public drop_end_date?: string;
    public grading_end_date?: string;
    public term: string;
    public reporting_term: string;
    public reporting_year: number;
    public current_status: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;
    public timestamp: string;

    public constructor(init?: Partial<SectionResponse>) { (Object as any).assign(this, init); }
}

export class SectionAvailableForStudentResponse extends SectionResponse
{
    public uuid: string;
    public studentSectionUUID: string;
    public registered_amount?: number;
    public is_full: boolean;
    public is_too_late: boolean;
    public is_too_early: boolean;
    public is_audit: boolean;
    public is_selected: boolean;
    public is_registered: boolean;
    public is_provisional: boolean;
    public is_missing_requisites: boolean;
    public is_completed: boolean;
    public maximum_credit_hours?: number;
    public maximum_audit_hours?: number;
    public can_retake: boolean;
    public is_credit_restricted: boolean;
    public is_audit_restricted: boolean;
    public is_oncampus_restricted_for_change: boolean;
    public is_online_restricted_for_change: boolean;
    public can_be_provisional: boolean;
    public can_be_dropped: boolean;
    public ruleMessages: string[];

    public constructor(init?: Partial<SectionAvailableForStudentResponse>) { super(init); (Object as any).assign(this, init); }
}

export class SectionsAvailableForStudentResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public reporting_term: string;
    public notifyOfAcademicProbation: boolean;
    public sectionsAvailable: SectionAvailableForStudentResponse[];
    public messages: string[];

    public constructor(init?: Partial<SectionsAvailableForStudentResponse>) { (Object as any).assign(this, init); }
}

export class SectionsAvailableToChangeForStudentRequest
{
    public uuid: string;
    public reporting_term: string;
    public online_only: boolean;

    public constructor(init?: Partial<SectionsAvailableToChangeForStudentRequest>) { (Object as any).assign(this, init); }
}

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