| Required role: | REGISUserRole |
| POST | /Sections/Admin/{reporting_term}/Create |
|---|
"use strict";
export class InstructorResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,regent_login?:string,preferred_name?:string,first_name?:string,last_name?:string,full_name?:string,email?:string,image_base64?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
regent_login;
/** @type {string} */
preferred_name;
/** @type {string} */
first_name;
/** @type {string} */
last_name;
/** @type {string} */
full_name;
/** @type {string} */
email;
/** @type {string} */
image_base64;
}
export class DocumentResponse {
/** @param {{code?:string,document_name?:string,document_description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
code;
/** @type {string} */
document_name;
/** @type {string} */
document_description;
}
export class SectionResponse {
/** @param {{responseStatus?:ResponseStatus,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?:InstructorResponse[],required_documents?:DocumentResponse[],start_date?:string,end_date?:string,first_meeting_date?:string,last_meeting_date?:string,meeting_days?:string,start_times?:string[],end_times?:string[],is_online_only?:boolean,is_weekend?:boolean,is_weekday?:boolean,is_evening?:boolean,is_waitlist?:boolean,has_special_requirements?:boolean,special_requirements?:string,is_unlisted?:boolean,credit_amounts?:number[],audit_amounts?:number[],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?:number,flat_fee_amount?:number,additional_fee_amount?:number,registered_students?:number,three_credit_plus?:number,two_credit?:number,one_credit?:number,three_audit_plus?:number,two_audit?:number,one_audit?:number,crosslist_registered_students?:number,grades_received?:number,crosslist_grades_received?:number,registration_start_date?:string,registration_end_date?:string,add_start_date?:string,add_end_date?:string,drop_start_date?:string,drop_end_date?:string,grading_end_date?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,timestamp?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
secUUID;
/** @type {string} */
course_name;
/** @type {string} */
section_code;
/** @type {string} */
course_title;
/** @type {string} */
course_short_title;
/** @type {string} */
course_description;
/** @type {string} */
crosslist_description;
/** @type {string} */
crosslist_course_name;
/** @type {string} */
location_long_name;
/** @type {string} */
room;
/** @type {InstructorResponse[]} */
instructors;
/** @type {DocumentResponse[]} */
required_documents;
/** @type {?string} */
start_date;
/** @type {?string} */
end_date;
/** @type {?string} */
first_meeting_date;
/** @type {?string} */
last_meeting_date;
/** @type {string} */
meeting_days;
/** @type {string[]} */
start_times;
/** @type {string[]} */
end_times;
/** @type {boolean} */
is_online_only;
/** @type {boolean} */
is_weekend;
/** @type {boolean} */
is_weekday;
/** @type {boolean} */
is_evening;
/** @type {boolean} */
is_waitlist;
/** @type {boolean} */
has_special_requirements;
/** @type {string} */
special_requirements;
/** @type {boolean} */
is_unlisted;
/** @type {number[]} */
credit_amounts;
/** @type {number[]} */
audit_amounts;
/** @type {string} */
audits_short_name;
/** @type {string} */
audits_long_name;
/** @type {string} */
credits_short_name;
/** @type {string} */
credits_long_name;
/** @type {string} */
distance_ed_materials;
/** @type {string} */
prerequisites;
/** @type {string} */
corequisites;
/** @type {?number} */
capacity;
/** @type {?number} */
flat_fee_amount;
/** @type {?number} */
additional_fee_amount;
/** @type {number} */
registered_students;
/** @type {number} */
three_credit_plus;
/** @type {number} */
two_credit;
/** @type {number} */
one_credit;
/** @type {number} */
three_audit_plus;
/** @type {number} */
two_audit;
/** @type {number} */
one_audit;
/** @type {number} */
crosslist_registered_students;
/** @type {number} */
grades_received;
/** @type {number} */
crosslist_grades_received;
/** @type {?string} */
registration_start_date;
/** @type {?string} */
registration_end_date;
/** @type {?string} */
add_start_date;
/** @type {?string} */
add_end_date;
/** @type {?string} */
drop_start_date;
/** @type {?string} */
drop_end_date;
/** @type {?string} */
grading_end_date;
/** @type {string} */
term;
/** @type {string} */
reporting_term;
/** @type {number} */
reporting_year;
/** @type {string} */
current_status;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
/** @type {string} */
timestamp;
}
export class SectionCreateRequest {
/** @param {{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,first_meeting_date?:string,last_meeting_date?:string,start_times?:string,end_times?:string,meeting_days?: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 {?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} */
first_meeting_date;
/** @type {?string} */
last_meeting_date;
/** @type {string} */
start_times;
/** @type {string} */
end_times;
/** @type {string} */
meeting_days;
/** @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 SectionCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Sections/Admin/{reporting_term}/Create HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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,
start_times: String,
end_times: String,
meeting_days: String,
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
{
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
}