| Required role: | REGISUserRole |
| POST | /Sections/Admin/{reporting_term} |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class SectionAdminResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $uuid=null,
/** @var int */
public int $section_id=0,
/** @var int|null */
public ?int $course_id=null,
/** @var string|null */
public ?string $course_name=null,
/** @var float|null */
public ?float $min_credits=null,
/** @var float|null */
public ?float $max_credits=null,
/** @var float|null */
public ?float $credit_increments=null,
/** @var float|null */
public ?float $min_audits=null,
/** @var float|null */
public ?float $max_audits=null,
/** @var float|null */
public ?float $audit_increments=null,
/** @var string|null */
public ?string $section_code=null,
/** @var string|null */
public ?string $title=null,
/** @var string|null */
public ?string $pretty_title=null,
/** @var string|null */
public ?string $override_course_description=null,
/** @var string|null */
public ?string $current_status=null,
/** @var string|null */
public ?string $location=null,
/** @var string|null */
public ?string $room=null,
/** @var bool|null */
public ?bool $is_audio=null,
/** @var bool|null */
public ?bool $is_oncampus=null,
/** @var string|null */
public ?string $distance_ed_materials=null,
/** @var DateTime|null */
public ?DateTime $start_date=null,
/** @var DateTime|null */
public ?DateTime $end_date=null,
/** @var DateTime|null */
public ?DateTime $first_meeting_date=null,
/** @var DateTime|null */
public ?DateTime $last_meeting_date=null,
/** @var string|null */
public ?string $meeting_days=null,
/** @var string|null */
public ?string $start_times=null,
/** @var string|null */
public ?string $end_times=null,
/** @var bool|null */
public ?bool $is_pass_fail=null,
/** @var bool|null */
public ?bool $is_weekend=null,
/** @var bool|null */
public ?bool $is_weekday=null,
/** @var bool|null */
public ?bool $is_evening=null,
/** @var bool|null */
public ?bool $is_waitlist=null,
/** @var bool|null */
public ?bool $has_special_requirements=null,
/** @var string|null */
public ?string $special_requirements=null,
/** @var bool|null */
public ?bool $is_unlisted=null,
/** @var int|null */
public ?int $capacity=null,
/** @var float|null */
public ?float $flat_fee_amount=null,
/** @var float|null */
public ?float $additional_fee_amount=null,
/** @var DateTime|null */
public ?DateTime $override_registration_start_date=null,
/** @var DateTime|null */
public ?DateTime $override_registration_end_date=null,
/** @var DateTime|null */
public ?DateTime $override_add_start_date=null,
/** @var DateTime|null */
public ?DateTime $override_add_end_date=null,
/** @var DateTime|null */
public ?DateTime $override_drop_start_date=null,
/** @var DateTime|null */
public ?DateTime $override_drop_end_date=null,
/** @var DateTime|null */
public ?DateTime $override_grading_end_date=null,
/** @var string|null */
public ?string $term=null,
/** @var string|null */
public ?string $reporting_term=null,
/** @var int */
public int $reporting_year=0,
/** @var DateTime|null */
public ?DateTime $added_date=null,
/** @var string|null */
public ?string $added_by=null,
/** @var DateTime|null */
public ?DateTime $changed_date=null,
/** @var string|null */
public ?string $changed_by=null,
/** @var DateTime */
public DateTime $timestamp=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['uuid'])) $this->uuid = $o['uuid'];
if (isset($o['section_id'])) $this->section_id = $o['section_id'];
if (isset($o['course_id'])) $this->course_id = $o['course_id'];
if (isset($o['course_name'])) $this->course_name = $o['course_name'];
if (isset($o['min_credits'])) $this->min_credits = $o['min_credits'];
if (isset($o['max_credits'])) $this->max_credits = $o['max_credits'];
if (isset($o['credit_increments'])) $this->credit_increments = $o['credit_increments'];
if (isset($o['min_audits'])) $this->min_audits = $o['min_audits'];
if (isset($o['max_audits'])) $this->max_audits = $o['max_audits'];
if (isset($o['audit_increments'])) $this->audit_increments = $o['audit_increments'];
if (isset($o['section_code'])) $this->section_code = $o['section_code'];
if (isset($o['title'])) $this->title = $o['title'];
if (isset($o['pretty_title'])) $this->pretty_title = $o['pretty_title'];
if (isset($o['override_course_description'])) $this->override_course_description = $o['override_course_description'];
if (isset($o['current_status'])) $this->current_status = $o['current_status'];
if (isset($o['location'])) $this->location = $o['location'];
if (isset($o['room'])) $this->room = $o['room'];
if (isset($o['is_audio'])) $this->is_audio = $o['is_audio'];
if (isset($o['is_oncampus'])) $this->is_oncampus = $o['is_oncampus'];
if (isset($o['distance_ed_materials'])) $this->distance_ed_materials = $o['distance_ed_materials'];
if (isset($o['start_date'])) $this->start_date = JsonConverters::from('DateTime', $o['start_date']);
if (isset($o['end_date'])) $this->end_date = JsonConverters::from('DateTime', $o['end_date']);
if (isset($o['first_meeting_date'])) $this->first_meeting_date = JsonConverters::from('DateTime', $o['first_meeting_date']);
if (isset($o['last_meeting_date'])) $this->last_meeting_date = JsonConverters::from('DateTime', $o['last_meeting_date']);
if (isset($o['meeting_days'])) $this->meeting_days = $o['meeting_days'];
if (isset($o['start_times'])) $this->start_times = $o['start_times'];
if (isset($o['end_times'])) $this->end_times = $o['end_times'];
if (isset($o['is_pass_fail'])) $this->is_pass_fail = $o['is_pass_fail'];
if (isset($o['is_weekend'])) $this->is_weekend = $o['is_weekend'];
if (isset($o['is_weekday'])) $this->is_weekday = $o['is_weekday'];
if (isset($o['is_evening'])) $this->is_evening = $o['is_evening'];
if (isset($o['is_waitlist'])) $this->is_waitlist = $o['is_waitlist'];
if (isset($o['has_special_requirements'])) $this->has_special_requirements = $o['has_special_requirements'];
if (isset($o['special_requirements'])) $this->special_requirements = $o['special_requirements'];
if (isset($o['is_unlisted'])) $this->is_unlisted = $o['is_unlisted'];
if (isset($o['capacity'])) $this->capacity = $o['capacity'];
if (isset($o['flat_fee_amount'])) $this->flat_fee_amount = $o['flat_fee_amount'];
if (isset($o['additional_fee_amount'])) $this->additional_fee_amount = $o['additional_fee_amount'];
if (isset($o['override_registration_start_date'])) $this->override_registration_start_date = JsonConverters::from('DateTime', $o['override_registration_start_date']);
if (isset($o['override_registration_end_date'])) $this->override_registration_end_date = JsonConverters::from('DateTime', $o['override_registration_end_date']);
if (isset($o['override_add_start_date'])) $this->override_add_start_date = JsonConverters::from('DateTime', $o['override_add_start_date']);
if (isset($o['override_add_end_date'])) $this->override_add_end_date = JsonConverters::from('DateTime', $o['override_add_end_date']);
if (isset($o['override_drop_start_date'])) $this->override_drop_start_date = JsonConverters::from('DateTime', $o['override_drop_start_date']);
if (isset($o['override_drop_end_date'])) $this->override_drop_end_date = JsonConverters::from('DateTime', $o['override_drop_end_date']);
if (isset($o['override_grading_end_date'])) $this->override_grading_end_date = JsonConverters::from('DateTime', $o['override_grading_end_date']);
if (isset($o['term'])) $this->term = $o['term'];
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['reporting_year'])) $this->reporting_year = $o['reporting_year'];
if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
if (isset($o['added_by'])) $this->added_by = $o['added_by'];
if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
if (isset($o['changed_by'])) $this->changed_by = $o['changed_by'];
if (isset($o['timestamp'])) $this->timestamp = JsonConverters::from('DateTime', $o['timestamp']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->uuid)) $o['uuid'] = $this->uuid;
if (isset($this->section_id)) $o['section_id'] = $this->section_id;
if (isset($this->course_id)) $o['course_id'] = $this->course_id;
if (isset($this->course_name)) $o['course_name'] = $this->course_name;
if (isset($this->min_credits)) $o['min_credits'] = $this->min_credits;
if (isset($this->max_credits)) $o['max_credits'] = $this->max_credits;
if (isset($this->credit_increments)) $o['credit_increments'] = $this->credit_increments;
if (isset($this->min_audits)) $o['min_audits'] = $this->min_audits;
if (isset($this->max_audits)) $o['max_audits'] = $this->max_audits;
if (isset($this->audit_increments)) $o['audit_increments'] = $this->audit_increments;
if (isset($this->section_code)) $o['section_code'] = $this->section_code;
if (isset($this->title)) $o['title'] = $this->title;
if (isset($this->pretty_title)) $o['pretty_title'] = $this->pretty_title;
if (isset($this->override_course_description)) $o['override_course_description'] = $this->override_course_description;
if (isset($this->current_status)) $o['current_status'] = $this->current_status;
if (isset($this->location)) $o['location'] = $this->location;
if (isset($this->room)) $o['room'] = $this->room;
if (isset($this->is_audio)) $o['is_audio'] = $this->is_audio;
if (isset($this->is_oncampus)) $o['is_oncampus'] = $this->is_oncampus;
if (isset($this->distance_ed_materials)) $o['distance_ed_materials'] = $this->distance_ed_materials;
if (isset($this->start_date)) $o['start_date'] = JsonConverters::to('DateTime', $this->start_date);
if (isset($this->end_date)) $o['end_date'] = JsonConverters::to('DateTime', $this->end_date);
if (isset($this->first_meeting_date)) $o['first_meeting_date'] = JsonConverters::to('DateTime', $this->first_meeting_date);
if (isset($this->last_meeting_date)) $o['last_meeting_date'] = JsonConverters::to('DateTime', $this->last_meeting_date);
if (isset($this->meeting_days)) $o['meeting_days'] = $this->meeting_days;
if (isset($this->start_times)) $o['start_times'] = $this->start_times;
if (isset($this->end_times)) $o['end_times'] = $this->end_times;
if (isset($this->is_pass_fail)) $o['is_pass_fail'] = $this->is_pass_fail;
if (isset($this->is_weekend)) $o['is_weekend'] = $this->is_weekend;
if (isset($this->is_weekday)) $o['is_weekday'] = $this->is_weekday;
if (isset($this->is_evening)) $o['is_evening'] = $this->is_evening;
if (isset($this->is_waitlist)) $o['is_waitlist'] = $this->is_waitlist;
if (isset($this->has_special_requirements)) $o['has_special_requirements'] = $this->has_special_requirements;
if (isset($this->special_requirements)) $o['special_requirements'] = $this->special_requirements;
if (isset($this->is_unlisted)) $o['is_unlisted'] = $this->is_unlisted;
if (isset($this->capacity)) $o['capacity'] = $this->capacity;
if (isset($this->flat_fee_amount)) $o['flat_fee_amount'] = $this->flat_fee_amount;
if (isset($this->additional_fee_amount)) $o['additional_fee_amount'] = $this->additional_fee_amount;
if (isset($this->override_registration_start_date)) $o['override_registration_start_date'] = JsonConverters::to('DateTime', $this->override_registration_start_date);
if (isset($this->override_registration_end_date)) $o['override_registration_end_date'] = JsonConverters::to('DateTime', $this->override_registration_end_date);
if (isset($this->override_add_start_date)) $o['override_add_start_date'] = JsonConverters::to('DateTime', $this->override_add_start_date);
if (isset($this->override_add_end_date)) $o['override_add_end_date'] = JsonConverters::to('DateTime', $this->override_add_end_date);
if (isset($this->override_drop_start_date)) $o['override_drop_start_date'] = JsonConverters::to('DateTime', $this->override_drop_start_date);
if (isset($this->override_drop_end_date)) $o['override_drop_end_date'] = JsonConverters::to('DateTime', $this->override_drop_end_date);
if (isset($this->override_grading_end_date)) $o['override_grading_end_date'] = JsonConverters::to('DateTime', $this->override_grading_end_date);
if (isset($this->term)) $o['term'] = $this->term;
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->reporting_year)) $o['reporting_year'] = $this->reporting_year;
if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
if (isset($this->added_by)) $o['added_by'] = $this->added_by;
if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
if (isset($this->changed_by)) $o['changed_by'] = $this->changed_by;
if (isset($this->timestamp)) $o['timestamp'] = JsonConverters::to('DateTime', $this->timestamp);
return empty($o) ? new class(){} : $o;
}
}
class SectionsAdminResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var string|null */
public ?string $reporting_term=null,
/** @var array<SectionAdminResponse>|null */
public ?array $sections=null,
/** @var array<string,SectionRateWithAmountResponse[]>|null */
public ?array $section_rates=null,
/** @var array<string,SectionRefundScheduleResponse[]>|null */
public ?array $section_refund_schedules=null,
/** @var array<string>|null */
public ?array $locations=null,
/** @var array<string,InstructorResponse[]>|null */
public ?array $section_instructors=null,
/** @var array<string,string[]>|null */
public ?array $section_document_codes=null,
/** @var array<string,int[]>|null */
public ?array $crosslisted_sections=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['sections'])) $this->sections = JsonConverters::fromArray('SectionAdminResponse', $o['sections']);
if (isset($o['section_rates'])) $this->section_rates = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['int','List<SectionRateWithAmountResponse>']), $o['section_rates']);
if (isset($o['section_refund_schedules'])) $this->section_refund_schedules = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['int','List<SectionRefundScheduleResponse>']), $o['section_refund_schedules']);
if (isset($o['locations'])) $this->locations = JsonConverters::fromArray('string', $o['locations']);
if (isset($o['section_instructors'])) $this->section_instructors = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['int','List<InstructorResponse>']), $o['section_instructors']);
if (isset($o['section_document_codes'])) $this->section_document_codes = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['int','List<String>']), $o['section_document_codes']);
if (isset($o['crosslisted_sections'])) $this->crosslisted_sections = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['int','List<Int32>']), $o['crosslisted_sections']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->sections)) $o['sections'] = JsonConverters::toArray('SectionAdminResponse', $this->sections);
if (isset($this->section_rates)) $o['section_rates'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['int','List<SectionRateWithAmountResponse>']), $this->section_rates);
if (isset($this->section_refund_schedules)) $o['section_refund_schedules'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['int','List<SectionRefundScheduleResponse>']), $this->section_refund_schedules);
if (isset($this->locations)) $o['locations'] = JsonConverters::toArray('string', $this->locations);
if (isset($this->section_instructors)) $o['section_instructors'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['int','List<InstructorResponse>']), $this->section_instructors);
if (isset($this->section_document_codes)) $o['section_document_codes'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['int','List<String>']), $this->section_document_codes);
if (isset($this->crosslisted_sections)) $o['crosslisted_sections'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['int','List<Int32>']), $this->crosslisted_sections);
return empty($o) ? new class(){} : $o;
}
}
class SectionsAdminRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $reporting_term=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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]}}