regis

<back to all web services

SectionCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/Admin/{reporting_term}/Create
SectionCreateRequest Parameters:
NameParameterData TypeRequiredDescription
course_idbodyint?No
course_namebodystringNo
min_creditsbodydecimal?No
max_creditsbodydecimal?No
credit_incrementsbodydecimal?No
min_auditsbodydecimal?No
max_auditsbodydecimal?No
audit_incrementsbodydecimal?No
section_codebodystringNo
titlebodystringNo
pretty_titlebodystringNo
override_course_descriptionbodystringNo
current_statusbodystringNo
locationbodystringNo
roombodystringNo
is_audiobodyboolNo
is_oncampusbodyboolNo
distance_ed_materialsbodystringNo
start_datebodyDateTime?No
end_datebodyDateTime?No
first_meeting_datebodyDateTime?No
last_meeting_datebodyDateTime?No
start_timesbodystringNo
end_timesbodystringNo
meeting_daysbodystringNo
is_pass_failbodyboolNo
is_waitlistbodyboolNo
has_special_requirementsbodyboolNo
special_requirementsbodystringNo
is_unlistedbodyboolNo
capacitybodyint?No
flat_fee_amountbodydecimal?No
additional_fee_amountbodydecimal?No
override_registration_start_datebodyDateTime?No
override_registration_end_datebodyDateTime?No
override_add_start_datebodyDateTime?No
override_add_end_datebodyDateTime?No
override_drop_start_datebodyDateTime?No
override_drop_end_datebodyDateTime?No
override_grading_end_datebodyDateTime?No
termbodystringNo
reporting_termpathstringNo
authorizing_uuidbodystringNo
SectionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
secUUIDformstringNo
course_nameformstringNo
section_codeformstringNo
course_titleformstringNo
course_short_titleformstringNo
course_descriptionformstringNo
crosslist_descriptionformstringNo
crosslist_course_nameformstringNo
location_long_nameformstringNo
roomformstringNo
instructorsformList<InstructorResponse>No
required_documentsformList<DocumentResponse>No
start_dateformDateTime?No
end_dateformDateTime?No
first_meeting_dateformDateTime?No
last_meeting_dateformDateTime?No
meeting_daysformstringNo
start_timesformList<string>No
end_timesformList<string>No
is_online_onlyformboolNo
is_weekendformboolNo
is_weekdayformboolNo
is_eveningformboolNo
is_waitlistformboolNo
has_special_requirementsformboolNo
special_requirementsformstringNo
is_unlistedformboolNo
credit_amountsformList<decimal>No
audit_amountsformList<decimal>No
audits_short_nameformstringNo
audits_long_nameformstringNo
credits_short_nameformstringNo
credits_long_nameformstringNo
distance_ed_materialsformstringNo
prerequisitesformstringNo
corequisitesformstringNo
capacityformint?No
flat_fee_amountformdecimal?No
additional_fee_amountformdecimal?No
registered_studentsformintNo
three_credit_plusformintNo
two_creditformintNo
one_creditformintNo
three_audit_plusformintNo
two_auditformintNo
one_auditformintNo
crosslist_registered_studentsformintNo
grades_receivedformintNo
crosslist_grades_receivedformintNo
registration_start_dateformDateTime?No
registration_end_dateformDateTime?No
add_start_dateformDateTime?No
add_end_dateformDateTime?No
drop_start_dateformDateTime?No
drop_end_dateformDateTime?No
grading_end_dateformDateTime?No
termformstringNo
reporting_termformstringNo
reporting_yearformintNo
current_statusformstringNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
timestampformDateTimeNo
InstructorResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
regent_loginformstringNo
preferred_nameformstringNo
first_nameformstringNo
last_nameformstringNo
full_nameformstringNo
emailformstringNo
image_base64formstringNo
DocumentResponse Parameters:
NameParameterData TypeRequiredDescription
codeformstringNo
document_nameformstringNo
document_descriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","first_meeting_date":"0001-01-01T00:00:00.0000000","last_meeting_date":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","override_registration_end_date":"0001-01-01T00:00:00.0000000","override_add_start_date":"0001-01-01T00:00:00.0000000","override_add_end_date":"0001-01-01T00:00:00.0000000","override_drop_start_date":"0001-01-01T00:00:00.0000000","override_drop_end_date":"0001-01-01T00:00:00.0000000","override_grading_end_date":"0001-01-01T00:00:00.0000000","term":"String","reporting_term":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","first_meeting_date":"0001-01-01T00:00:00.0000000","last_meeting_date":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","registration_end_date":"0001-01-01T00:00:00.0000000","add_start_date":"0001-01-01T00:00:00.0000000","add_end_date":"0001-01-01T00:00:00.0000000","drop_start_date":"0001-01-01T00:00:00.0000000","drop_end_date":"0001-01-01T00:00:00.0000000","grading_end_date":"0001-01-01T00:00:00.0000000","term":"String","reporting_term":"String","reporting_year":0,"current_status":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000","timestamp":"0001-01-01T00:00:00.0000000"}