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}

export class SectionAdminResponse
{
    public uuid: string;
    public section_id: number;
    public course_id?: number;
    public course_name: string;
    public min_credits?: number;
    public max_credits?: number;
    public credit_increments?: number;
    public min_audits?: number;
    public max_audits?: number;
    public audit_increments?: number;
    public section_code: string;
    public title: string;
    public pretty_title: string;
    public override_course_description: string;
    public current_status: string;
    public location: string;
    public room: string;
    public is_audio: boolean;
    public is_oncampus: boolean;
    public distance_ed_materials: string;
    public start_date?: string;
    public end_date?: string;
    public first_meeting_date?: string;
    public last_meeting_date?: string;
    public meeting_days: string;
    public start_times: string;
    public end_times: string;
    public is_pass_fail: boolean;
    public is_weekend: boolean;
    public is_weekday: boolean;
    public is_evening: boolean;
    public is_waitlist: boolean;
    public has_special_requirements: boolean;
    public special_requirements: string;
    public is_unlisted: boolean;
    public capacity?: number;
    public flat_fee_amount?: number;
    public additional_fee_amount?: number;
    public override_registration_start_date?: string;
    public override_registration_end_date?: string;
    public override_add_start_date?: string;
    public override_add_end_date?: string;
    public override_drop_start_date?: string;
    public override_drop_end_date?: string;
    public override_grading_end_date?: string;
    public term: string;
    public reporting_term: string;
    public reporting_year: number;
    public added_date?: string;
    public added_by: string;
    public changed_date?: string;
    public changed_by: string;
    public timestamp: string;

    public constructor(init?: Partial<SectionAdminResponse>) { (Object as any).assign(this, init); }
}

export class SectionsAdminResponse
{
    public responseStatus: ResponseStatus;
    public reporting_term: string;
    public sections: SectionAdminResponse[];
    public section_rates: { [index: number]: SectionRateWithAmountResponse[]; };
    public section_refund_schedules: { [index: number]: SectionRefundScheduleResponse[]; };
    public locations: string[];
    public section_instructors: { [index: number]: InstructorResponse[]; };
    public section_document_codes: { [index: number]: string[]; };
    public crosslisted_sections: { [index: number]: number[]; };

    public constructor(init?: Partial<SectionsAdminResponse>) { (Object as any).assign(this, init); }
}

export class SectionsAdminRequest
{
    public reporting_term: string;

    public constructor(init?: Partial<SectionsAdminRequest>) { (Object as any).assign(this, init); }
}

TypeScript SectionsAdminRequest DTOs

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]}}