regis

<back to all web services

SectionsAdminRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/Admin/{reporting_term}
SectionsAdminRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termpathstringNo
SectionsAdminResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
reporting_termformstringNo
sectionsformList<SectionAdminResponse>No
section_ratesformDictionary<int, List<SectionRateWithAmountResponse>>No
section_refund_schedulesformDictionary<int, List<SectionRefundScheduleResponse>>No
locationsformList<string>No
section_instructorsformDictionary<int, List<InstructorResponse>>No
section_document_codesformDictionary<int, List<String>>No
crosslisted_sectionsformDictionary<int, List<Int32>>No
SectionAdminResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
section_idformintNo
course_idformint?No
course_nameformstringNo
min_creditsformdecimal?No
max_creditsformdecimal?No
credit_incrementsformdecimal?No
min_auditsformdecimal?No
max_auditsformdecimal?No
audit_incrementsformdecimal?No
section_codeformstringNo
titleformstringNo
pretty_titleformstringNo
override_course_descriptionformstringNo
current_statusformstringNo
locationformstringNo
roomformstringNo
is_audioformboolNo
is_oncampusformboolNo
distance_ed_materialsformstringNo
start_dateformDateTime?No
end_dateformDateTime?No
first_meeting_dateformDateTime?No
last_meeting_dateformDateTime?No
meeting_daysformstringNo
start_timesformstringNo
end_timesformstringNo
is_pass_failformboolNo
is_weekendformboolNo
is_weekdayformboolNo
is_eveningformboolNo
is_waitlistformboolNo
has_special_requirementsformboolNo
special_requirementsformstringNo
is_unlistedformboolNo
capacityformint?No
flat_fee_amountformdecimal?No
additional_fee_amountformdecimal?No
override_registration_start_dateformDateTime?No
override_registration_end_dateformDateTime?No
override_add_start_dateformDateTime?No
override_add_end_dateformDateTime?No
override_drop_start_dateformDateTime?No
override_drop_end_dateformDateTime?No
override_grading_end_dateformDateTime?No
termformstringNo
reporting_termformstringNo
reporting_yearformintNo
added_dateformDateTime?No
added_byformstringNo
changed_dateformDateTime?No
changed_byformstringNo
timestampformDateTimeNo

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"reporting_term":"String","sections":[{"uuid":"String","section_id":0,"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","meeting_days":"String","start_times":"String","end_times":"String","is_pass_fail":false,"is_weekend":false,"is_weekday":false,"is_evening":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","reporting_year":0,"added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}],"section_rates":{"0":[{"rate_id":0,"charge":0,"credit":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","secUUID":"String","section_id":0,"course_name":"String","section_code":"String","title":"String","reporting_term":"String","rate_code":"String","rate_description":"String","is_override_credit_rate":false,"is_override_audit_rate":false}]},"section_refund_schedules":{"0":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","secUUID":"String","section_id":0,"course_name":"String","section_code":"String","title":"String","reporting_term":"String","rate_code":"String","rate_description":"String","percentage":0,"start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000"}]},"locations":["String"],"section_instructors":{"0":[{"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"}]},"section_document_codes":{"0":["String"]},"crosslisted_sections":{"0":[0]}}