| Required role: | REGISUserRole |
| POST | /Sections/Available/{uuid}/Term/{reporting_term} |
|---|
"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 SectionAvailableForStudentResponse extends SectionResponse {
/** @param {{uuid?:string,studentSectionUUID?:string,registered_amount?:number,is_full?:boolean,is_too_late?:boolean,is_too_early?:boolean,is_audit?:boolean,is_selected?:boolean,is_registered?:boolean,is_provisional?:boolean,is_missing_requisites?:boolean,is_completed?:boolean,maximum_credit_hours?:number,maximum_audit_hours?:number,can_retake?:boolean,is_credit_restricted?:boolean,is_audit_restricted?:boolean,is_oncampus_restricted_for_change?:boolean,is_online_restricted_for_change?:boolean,can_be_provisional?:boolean,can_be_dropped?:boolean,ruleMessages?:string[],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) { super(init); Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {string} */
studentSectionUUID;
/** @type {?number} */
registered_amount;
/** @type {boolean} */
is_full;
/** @type {boolean} */
is_too_late;
/** @type {boolean} */
is_too_early;
/** @type {boolean} */
is_audit;
/** @type {boolean} */
is_selected;
/** @type {boolean} */
is_registered;
/** @type {boolean} */
is_provisional;
/** @type {boolean} */
is_missing_requisites;
/** @type {boolean} */
is_completed;
/** @type {?number} */
maximum_credit_hours;
/** @type {?number} */
maximum_audit_hours;
/** @type {boolean} */
can_retake;
/** @type {boolean} */
is_credit_restricted;
/** @type {boolean} */
is_audit_restricted;
/** @type {boolean} */
is_oncampus_restricted_for_change;
/** @type {boolean} */
is_online_restricted_for_change;
/** @type {boolean} */
can_be_provisional;
/** @type {boolean} */
can_be_dropped;
/** @type {string[]} */
ruleMessages;
}
export class SectionsAvailableForStudentResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,reporting_term?:string,notifyOfAcademicProbation?:boolean,sectionsAvailable?:SectionAvailableForStudentResponse[],messages?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {string} */
reporting_term;
/** @type {boolean} */
notifyOfAcademicProbation;
/** @type {SectionAvailableForStudentResponse[]} */
sectionsAvailable;
/** @type {string[]} */
messages;
}
export class SectionsAvailableForStudentRequest {
/** @param {{uuid?:string,transaction_uuid?:string,reporting_term?:string,online_only?:boolean,oncampus_only?:boolean,is_admin?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {string} */
transaction_uuid;
/** @type {string} */
reporting_term;
/** @type {boolean} */
online_only;
/** @type {boolean} */
oncampus_only;
/** @type {boolean} */
is_admin;
}
JavaScript SectionsAvailableForStudentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Sections/Available/{uuid}/Term/{reporting_term} HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SectionsAvailableForStudentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<is_admin>false</is_admin>
<oncampus_only>false</oncampus_only>
<online_only>false</online_only>
<reporting_term>String</reporting_term>
<transaction_uuid>String</transaction_uuid>
<uuid>String</uuid>
</SectionsAvailableForStudentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SectionsAvailableForStudentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</messages>
<notifyOfAcademicProbation>false</notifyOfAcademicProbation>
<regent_id>0</regent_id>
<reporting_term>String</reporting_term>
<sectionsAvailable>
<SectionAvailableForStudentResponse>
<ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:Message>String</d4p1:Message>
<d4p1:StackTrace>String</d4p1:StackTrace>
<d4p1:Errors>
<d4p1:ResponseError>
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:FieldName>String</d4p1:FieldName>
<d4p1:Message>String</d4p1:Message>
<d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d4p1:Meta>
</d4p1:ResponseError>
</d4p1:Errors>
<d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d4p1:Meta>
</ResponseStatus>
<add_end_date>0001-01-01T00:00:00</add_end_date>
<add_start_date>0001-01-01T00:00:00</add_start_date>
<added_by>String</added_by>
<added_date>0001-01-01T00:00:00</added_date>
<additional_fee_amount>0</additional_fee_amount>
<audit_amounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:decimal>0</d4p1:decimal>
</audit_amounts>
<audits_long_name>String</audits_long_name>
<audits_short_name>String</audits_short_name>
<capacity>0</capacity>
<changed_by>String</changed_by>
<changed_date>0001-01-01T00:00:00</changed_date>
<corequisites>String</corequisites>
<course_description>String</course_description>
<course_name>String</course_name>
<course_short_title>String</course_short_title>
<course_title>String</course_title>
<credit_amounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:decimal>0</d4p1:decimal>
</credit_amounts>
<credits_long_name>String</credits_long_name>
<credits_short_name>String</credits_short_name>
<crosslist_course_name>String</crosslist_course_name>
<crosslist_description>String</crosslist_description>
<crosslist_grades_received>0</crosslist_grades_received>
<crosslist_registered_students>0</crosslist_registered_students>
<current_status>String</current_status>
<distance_ed_materials>String</distance_ed_materials>
<drop_end_date>0001-01-01T00:00:00</drop_end_date>
<drop_start_date>0001-01-01T00:00:00</drop_start_date>
<end_date>0001-01-01T00:00:00</end_date>
<end_times xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</end_times>
<first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
<flat_fee_amount>0</flat_fee_amount>
<grades_received>0</grades_received>
<grading_end_date>0001-01-01T00:00:00</grading_end_date>
<has_special_requirements>false</has_special_requirements>
<instructors>
<InstructorResponse>
<ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types">
<d6p1:ErrorCode>String</d6p1:ErrorCode>
<d6p1:Message>String</d6p1:Message>
<d6p1:StackTrace>String</d6p1:StackTrace>
<d6p1:Errors>
<d6p1:ResponseError>
<d6p1:ErrorCode>String</d6p1:ErrorCode>
<d6p1:FieldName>String</d6p1:FieldName>
<d6p1:Message>String</d6p1:Message>
<d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d9p1:KeyValueOfstringstring>
<d9p1:Key>String</d9p1:Key>
<d9p1:Value>String</d9p1:Value>
</d9p1:KeyValueOfstringstring>
</d6p1:Meta>
</d6p1:ResponseError>
</d6p1:Errors>
<d6p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d6p1:Meta>
</ResponseStatus>
<email>String</email>
<first_name>String</first_name>
<full_name>String</full_name>
<image_base64>String</image_base64>
<last_name>String</last_name>
<preferred_name>String</preferred_name>
<regent_id>0</regent_id>
<regent_login>String</regent_login>
</InstructorResponse>
</instructors>
<is_evening>false</is_evening>
<is_online_only>false</is_online_only>
<is_unlisted>false</is_unlisted>
<is_waitlist>false</is_waitlist>
<is_weekday>false</is_weekday>
<is_weekend>false</is_weekend>
<last_meeting_date>0001-01-01T00:00:00</last_meeting_date>
<location_long_name>String</location_long_name>
<meeting_days>String</meeting_days>
<one_audit>0</one_audit>
<one_credit>0</one_credit>
<prerequisites>String</prerequisites>
<registered_students>0</registered_students>
<registration_end_date>0001-01-01T00:00:00</registration_end_date>
<registration_start_date>0001-01-01T00:00:00</registration_start_date>
<reporting_term>String</reporting_term>
<reporting_year>0</reporting_year>
<required_documents>
<DocumentResponse>
<code>String</code>
<document_description>String</document_description>
<document_name>String</document_name>
</DocumentResponse>
</required_documents>
<room>String</room>
<secUUID>String</secUUID>
<section_code>String</section_code>
<special_requirements>String</special_requirements>
<start_date>0001-01-01T00:00:00</start_date>
<start_times xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</start_times>
<term>String</term>
<three_audit_plus>0</three_audit_plus>
<three_credit_plus>0</three_credit_plus>
<timestamp>0001-01-01T00:00:00</timestamp>
<two_audit>0</two_audit>
<two_credit>0</two_credit>
<can_be_dropped>false</can_be_dropped>
<can_be_provisional>false</can_be_provisional>
<can_retake>false</can_retake>
<is_audit>false</is_audit>
<is_audit_restricted>false</is_audit_restricted>
<is_completed>false</is_completed>
<is_credit_restricted>false</is_credit_restricted>
<is_full>false</is_full>
<is_missing_requisites>false</is_missing_requisites>
<is_oncampus_restricted_for_change>false</is_oncampus_restricted_for_change>
<is_online_restricted_for_change>false</is_online_restricted_for_change>
<is_provisional>false</is_provisional>
<is_registered>false</is_registered>
<is_selected>false</is_selected>
<is_too_early>false</is_too_early>
<is_too_late>false</is_too_late>
<maximum_audit_hours>0</maximum_audit_hours>
<maximum_credit_hours>0</maximum_credit_hours>
<registered_amount>0</registered_amount>
<ruleMessages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</ruleMessages>
<studentSectionUUID>String</studentSectionUUID>
<uuid>String</uuid>
</SectionAvailableForStudentResponse>
</sectionsAvailable>
<uuid>String</uuid>
</SectionsAvailableForStudentResponse>