| Required role: | REGISUserRole |
| POST | /Sections/Admin/{reporting_term} |
|---|
"use strict";
export class SectionAdminResponse {
/** @param {{uuid?:string,section_id?:number,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,meeting_days?:string,start_times?:string,end_times?:string,is_pass_fail?:boolean,is_weekend?:boolean,is_weekday?:boolean,is_evening?: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,reporting_year?:number,added_date?:string,added_by?:string,changed_date?:string,changed_by?:string,timestamp?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {number} */
section_id;
/** @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} */
meeting_days;
/** @type {string} */
start_times;
/** @type {string} */
end_times;
/** @type {boolean} */
is_pass_fail;
/** @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} */
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 {number} */
reporting_year;
/** @type {?string} */
added_date;
/** @type {string} */
added_by;
/** @type {?string} */
changed_date;
/** @type {string} */
changed_by;
/** @type {string} */
timestamp;
}
export class SectionsAdminResponse {
/** @param {{responseStatus?:ResponseStatus,reporting_term?:string,sections?:SectionAdminResponse[],section_rates?:{ [index: number]: SectionRateWithAmountResponse[]; },section_refund_schedules?:{ [index: number]: SectionRefundScheduleResponse[]; },locations?:string[],section_instructors?:{ [index: number]: InstructorResponse[]; },section_document_codes?:{ [index: number]: string[]; },crosslisted_sections?:{ [index: number]: number[]; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
reporting_term;
/** @type {SectionAdminResponse[]} */
sections;
/** @type {{ [index: number]: SectionRateWithAmountResponse[]; }} */
section_rates;
/** @type {{ [index: number]: SectionRefundScheduleResponse[]; }} */
section_refund_schedules;
/** @type {string[]} */
locations;
/** @type {{ [index: number]: InstructorResponse[]; }} */
section_instructors;
/** @type {{ [index: number]: string[]; }} */
section_document_codes;
/** @type {{ [index: number]: number[]; }} */
crosslisted_sections;
}
export class SectionsAdminRequest {
/** @param {{reporting_term?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
reporting_term;
}
JavaScript SectionsAdminRequest 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/Admin/{reporting_term} HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SectionsAdminRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<reporting_term>String</reporting_term>
</SectionsAdminRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SectionsAdminResponse 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>
<crosslisted_sections xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfintArrayOfintty7Ep6D1>
<d2p1:Key>0</d2p1:Key>
<d2p1:Value>
<d2p1:int>0</d2p1:int>
</d2p1:Value>
</d2p1:KeyValueOfintArrayOfintty7Ep6D1>
</crosslisted_sections>
<locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</locations>
<reporting_term>String</reporting_term>
<section_document_codes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfintArrayOfstringty7Ep6D1>
<d2p1:Key>0</d2p1:Key>
<d2p1:Value>
<d2p1:string>String</d2p1:string>
</d2p1:Value>
</d2p1:KeyValueOfintArrayOfstringty7Ep6D1>
</section_document_codes>
<section_instructors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfintArrayOfInstructorResponsezpaGewPN>
<d2p1:Key>0</d2p1:Key>
<d2p1:Value>
<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>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</d6p1:Meta>
</d6p1:ResponseError>
</d6p1:Errors>
<d6p1:Meta>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1: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>
</d2p1:Value>
</d2p1:KeyValueOfintArrayOfInstructorResponsezpaGewPN>
</section_instructors>
<section_rates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfintArrayOfSectionRateWithAmountResponsezpaGewPN>
<d2p1:Key>0</d2p1:Key>
<d2p1:Value>
<SectionRateWithAmountResponse>
<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>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</d6p1:Meta>
</d6p1:ResponseError>
</d6p1:Errors>
<d6p1:Meta>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</d6p1:Meta>
</ResponseStatus>
<course_name>String</course_name>
<is_override_audit_rate>false</is_override_audit_rate>
<is_override_credit_rate>false</is_override_credit_rate>
<rate_code>String</rate_code>
<rate_description>String</rate_description>
<reporting_term>String</reporting_term>
<secUUID>String</secUUID>
<section_code>String</section_code>
<section_id>0</section_id>
<title>String</title>
<uuid>String</uuid>
<charge>0</charge>
<credit>0</credit>
<rate_id>0</rate_id>
</SectionRateWithAmountResponse>
</d2p1:Value>
</d2p1:KeyValueOfintArrayOfSectionRateWithAmountResponsezpaGewPN>
</section_rates>
<section_refund_schedules xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfintArrayOfSectionRefundScheduleResponsezpaGewPN>
<d2p1:Key>0</d2p1:Key>
<d2p1:Value>
<SectionRefundScheduleResponse>
<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>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</d6p1:Meta>
</d6p1:ResponseError>
</d6p1:Errors>
<d6p1:Meta>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</d6p1:Meta>
</ResponseStatus>
<course_name>String</course_name>
<end_date>0001-01-01T00:00:00</end_date>
<percentage>0</percentage>
<rate_code>String</rate_code>
<rate_description>String</rate_description>
<reporting_term>String</reporting_term>
<secUUID>String</secUUID>
<section_code>String</section_code>
<section_id>0</section_id>
<start_date>0001-01-01T00:00:00</start_date>
<title>String</title>
<uuid>String</uuid>
</SectionRefundScheduleResponse>
</d2p1:Value>
</d2p1:KeyValueOfintArrayOfSectionRefundScheduleResponsezpaGewPN>
</section_refund_schedules>
<sections>
<SectionAdminResponse>
<added_by>String</added_by>
<added_date>0001-01-01T00:00:00</added_date>
<additional_fee_amount>0</additional_fee_amount>
<audit_increments>0</audit_increments>
<capacity>0</capacity>
<changed_by>String</changed_by>
<changed_date>0001-01-01T00:00:00</changed_date>
<course_id>0</course_id>
<course_name>String</course_name>
<credit_increments>0</credit_increments>
<current_status>String</current_status>
<distance_ed_materials>String</distance_ed_materials>
<end_date>0001-01-01T00:00:00</end_date>
<end_times>String</end_times>
<first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
<flat_fee_amount>0</flat_fee_amount>
<has_special_requirements>false</has_special_requirements>
<is_audio>false</is_audio>
<is_evening>false</is_evening>
<is_oncampus>false</is_oncampus>
<is_pass_fail>false</is_pass_fail>
<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>String</location>
<max_audits>0</max_audits>
<max_credits>0</max_credits>
<meeting_days>String</meeting_days>
<min_audits>0</min_audits>
<min_credits>0</min_credits>
<override_add_end_date>0001-01-01T00:00:00</override_add_end_date>
<override_add_start_date>0001-01-01T00:00:00</override_add_start_date>
<override_course_description>String</override_course_description>
<override_drop_end_date>0001-01-01T00:00:00</override_drop_end_date>
<override_drop_start_date>0001-01-01T00:00:00</override_drop_start_date>
<override_grading_end_date>0001-01-01T00:00:00</override_grading_end_date>
<override_registration_end_date>0001-01-01T00:00:00</override_registration_end_date>
<override_registration_start_date>0001-01-01T00:00:00</override_registration_start_date>
<pretty_title>String</pretty_title>
<reporting_term>String</reporting_term>
<reporting_year>0</reporting_year>
<room>String</room>
<section_code>String</section_code>
<section_id>0</section_id>
<special_requirements>String</special_requirements>
<start_date>0001-01-01T00:00:00</start_date>
<start_times>String</start_times>
<term>String</term>
<timestamp>0001-01-01T00:00:00</timestamp>
<title>String</title>
<uuid>String</uuid>
</SectionAdminResponse>
</sections>
</SectionsAdminResponse>