regis

<back to all web services

SectionUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/Admin/Update/{uuid}
"use strict";
export class SectionUpdateRequest {
    /** @param {{uuid?:string,course_id?:number,course_name?:string,min_credits?:number,max_credits?:number,credit_increments?:number,min_audits?:number,max_audits?:number,audit_increments?:number,section_code?:string,title?:string,pretty_title?:string,override_course_description?:string,current_status?:string,location?:string,room?:string,is_audio?:boolean,is_oncampus?:boolean,distance_ed_materials?:string,start_date?:string,end_date?:string,meeting_days?:string,start_times?:string,end_times?:string,first_meeting_date?:string,last_meeting_date?:string,is_pass_fail?:boolean,is_waitlist?:boolean,has_special_requirements?:boolean,special_requirements?:string,is_unlisted?:boolean,capacity?:number,flat_fee_amount?:number,additional_fee_amount?:number,override_registration_start_date?:string,override_registration_end_date?:string,override_add_start_date?:string,override_add_end_date?:string,override_drop_start_date?:string,override_drop_end_date?:string,override_grading_end_date?:string,term?:string,reporting_term?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {?number} */
    course_id;
    /** @type {string} */
    course_name;
    /** @type {?number} */
    min_credits;
    /** @type {?number} */
    max_credits;
    /** @type {?number} */
    credit_increments;
    /** @type {?number} */
    min_audits;
    /** @type {?number} */
    max_audits;
    /** @type {?number} */
    audit_increments;
    /** @type {string} */
    section_code;
    /** @type {string} */
    title;
    /** @type {string} */
    pretty_title;
    /** @type {string} */
    override_course_description;
    /** @type {string} */
    current_status;
    /** @type {string} */
    location;
    /** @type {string} */
    room;
    /** @type {boolean} */
    is_audio;
    /** @type {boolean} */
    is_oncampus;
    /** @type {string} */
    distance_ed_materials;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {string} */
    meeting_days;
    /** @type {string} */
    start_times;
    /** @type {string} */
    end_times;
    /** @type {?string} */
    first_meeting_date;
    /** @type {?string} */
    last_meeting_date;
    /** @type {boolean} */
    is_pass_fail;
    /** @type {boolean} */
    is_waitlist;
    /** @type {boolean} */
    has_special_requirements;
    /** @type {string} */
    special_requirements;
    /** @type {boolean} */
    is_unlisted;
    /** @type {?number} */
    capacity;
    /** @type {?number} */
    flat_fee_amount;
    /** @type {?number} */
    additional_fee_amount;
    /** @type {?string} */
    override_registration_start_date;
    /** @type {?string} */
    override_registration_end_date;
    /** @type {?string} */
    override_add_start_date;
    /** @type {?string} */
    override_add_end_date;
    /** @type {?string} */
    override_drop_start_date;
    /** @type {?string} */
    override_drop_end_date;
    /** @type {?string} */
    override_grading_end_date;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    authorizing_uuid;
}

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

{
	uuid: String,
	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,
	meeting_days: String,
	start_times: String,
	end_times: String,
	first_meeting_date: 0001-01-01,
	last_meeting_date: 0001-01-01,
	is_pass_fail: 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,
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}