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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class SectionsAdminRequest
    {
        public virtual string reporting_term { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class SectionAdminResponse
    {
        public virtual string uuid { get; set; }
        public virtual int section_id { get; set; }
        public virtual int? course_id { get; set; }
        public virtual string course_name { get; set; }
        public virtual decimal? min_credits { get; set; }
        public virtual decimal? max_credits { get; set; }
        public virtual decimal? credit_increments { get; set; }
        public virtual decimal? min_audits { get; set; }
        public virtual decimal? max_audits { get; set; }
        public virtual decimal? audit_increments { get; set; }
        public virtual string section_code { get; set; }
        public virtual string title { get; set; }
        public virtual string pretty_title { get; set; }
        public virtual string override_course_description { get; set; }
        public virtual string current_status { get; set; }
        public virtual string location { get; set; }
        public virtual string room { get; set; }
        public virtual bool is_audio { get; set; }
        public virtual bool is_oncampus { get; set; }
        public virtual string distance_ed_materials { get; set; }
        public virtual DateTime? start_date { get; set; }
        public virtual DateTime? end_date { get; set; }
        public virtual DateTime? first_meeting_date { get; set; }
        public virtual DateTime? last_meeting_date { get; set; }
        public virtual string meeting_days { get; set; }
        public virtual string start_times { get; set; }
        public virtual string end_times { get; set; }
        public virtual bool is_pass_fail { get; set; }
        public virtual bool is_weekend { get; set; }
        public virtual bool is_weekday { get; set; }
        public virtual bool is_evening { get; set; }
        public virtual bool is_waitlist { get; set; }
        public virtual bool has_special_requirements { get; set; }
        public virtual string special_requirements { get; set; }
        public virtual bool is_unlisted { get; set; }
        public virtual int? capacity { get; set; }
        public virtual decimal? flat_fee_amount { get; set; }
        public virtual decimal? additional_fee_amount { get; set; }
        public virtual DateTime? override_registration_start_date { get; set; }
        public virtual DateTime? override_registration_end_date { get; set; }
        public virtual DateTime? override_add_start_date { get; set; }
        public virtual DateTime? override_add_end_date { get; set; }
        public virtual DateTime? override_drop_start_date { get; set; }
        public virtual DateTime? override_drop_end_date { get; set; }
        public virtual DateTime? override_grading_end_date { get; set; }
        public virtual string term { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual int reporting_year { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime timestamp { get; set; }
    }

    public partial class SectionsAdminResponse
    {
        public SectionsAdminResponse()
        {
            sections = new List<SectionAdminResponse>{};
            section_rates = new Dictionary<int, List<SectionRateWithAmountResponse>>{};
            section_refund_schedules = new Dictionary<int, List<SectionRefundScheduleResponse>>{};
            locations = new List<string>{};
            section_instructors = new Dictionary<int, List<InstructorResponse>>{};
            section_document_codes = new Dictionary<int, List<String>>{};
            crosslisted_sections = new Dictionary<int, List<Int32>>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual List<SectionAdminResponse> sections { get; set; }
        public virtual Dictionary<int, List<SectionRateWithAmountResponse>> section_rates { get; set; }
        public virtual Dictionary<int, List<SectionRefundScheduleResponse>> section_refund_schedules { get; set; }
        public virtual List<string> locations { get; set; }
        public virtual Dictionary<int, List<InstructorResponse>> section_instructors { get; set; }
        public virtual Dictionary<int, List<String>> section_document_codes { get; set; }
        public virtual Dictionary<int, List<Int32>> crosslisted_sections { get; set; }
    }

}

C# SectionsAdminRequest DTOs

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

HTTP + JSV

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

{
	reporting_term: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			end_date: 0001-01-01,
			first_meeting_date: 0001-01-01,
			last_meeting_date: 0001-01-01,
			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-01,
			override_registration_end_date: 0001-01-01,
			override_add_start_date: 0001-01-01,
			override_add_end_date: 0001-01-01,
			override_drop_start_date: 0001-01-01,
			override_drop_end_date: 0001-01-01,
			override_grading_end_date: 0001-01-01,
			term: String,
			reporting_term: String,
			reporting_year: 0,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	],
	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-01,
				end_date: 0001-01-01
			}
		]
	},
	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
		]
	}
}