regis

<back to all web services

SectionsAvailableForStudentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/Available/{uuid}/Term/{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 SectionsAvailableForStudentRequest
    {
        public virtual string uuid { get; set; }
        public virtual string transaction_uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual bool online_only { get; set; }
        public virtual bool oncampus_only { get; set; }
        public virtual bool is_admin { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class DocumentResponse
    {
        public virtual string code { get; set; }
        public virtual string document_name { get; set; }
        public virtual string document_description { get; set; }
    }

    public partial class InstructorResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string regent_login { get; set; }
        public virtual string preferred_name { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string full_name { get; set; }
        public virtual string email { get; set; }
        public virtual string image_base64 { get; set; }
    }

    public partial class SectionAvailableForStudentResponse
        : SectionResponse
    {
        public SectionAvailableForStudentResponse()
        {
            ruleMessages = new List<string>{};
        }

        public virtual string uuid { get; set; }
        public virtual string studentSectionUUID { get; set; }
        public virtual decimal? registered_amount { get; set; }
        public virtual bool is_full { get; set; }
        public virtual bool is_too_late { get; set; }
        public virtual bool is_too_early { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual bool is_selected { get; set; }
        public virtual bool is_registered { get; set; }
        public virtual bool is_provisional { get; set; }
        public virtual bool is_missing_requisites { get; set; }
        public virtual bool is_completed { get; set; }
        public virtual decimal? maximum_credit_hours { get; set; }
        public virtual decimal? maximum_audit_hours { get; set; }
        public virtual bool can_retake { get; set; }
        public virtual bool is_credit_restricted { get; set; }
        public virtual bool is_audit_restricted { get; set; }
        public virtual bool is_oncampus_restricted_for_change { get; set; }
        public virtual bool is_online_restricted_for_change { get; set; }
        public virtual bool can_be_provisional { get; set; }
        public virtual bool can_be_dropped { get; set; }
        public virtual List<string> ruleMessages { get; set; }
    }

    public partial class SectionResponse
    {
        public SectionResponse()
        {
            instructors = new List<InstructorResponse>{};
            required_documents = new List<DocumentResponse>{};
            start_times = new List<string>{};
            end_times = new List<string>{};
            credit_amounts = new List<decimal>{};
            audit_amounts = new List<decimal>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string secUUID { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual string course_title { get; set; }
        public virtual string course_short_title { get; set; }
        public virtual string course_description { get; set; }
        public virtual string crosslist_description { get; set; }
        public virtual string crosslist_course_name { get; set; }
        public virtual string location_long_name { get; set; }
        public virtual string room { get; set; }
        public virtual List<InstructorResponse> instructors { get; set; }
        public virtual List<DocumentResponse> required_documents { 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 List<string> start_times { get; set; }
        public virtual List<string> end_times { get; set; }
        public virtual bool is_online_only { 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 List<decimal> credit_amounts { get; set; }
        public virtual List<decimal> audit_amounts { get; set; }
        public virtual string audits_short_name { get; set; }
        public virtual string audits_long_name { get; set; }
        public virtual string credits_short_name { get; set; }
        public virtual string credits_long_name { get; set; }
        public virtual string distance_ed_materials { get; set; }
        public virtual string prerequisites { get; set; }
        public virtual string corequisites { 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 int registered_students { get; set; }
        public virtual int three_credit_plus { get; set; }
        public virtual int two_credit { get; set; }
        public virtual int one_credit { get; set; }
        public virtual int three_audit_plus { get; set; }
        public virtual int two_audit { get; set; }
        public virtual int one_audit { get; set; }
        public virtual int crosslist_registered_students { get; set; }
        public virtual int grades_received { get; set; }
        public virtual int crosslist_grades_received { get; set; }
        public virtual DateTime? registration_start_date { get; set; }
        public virtual DateTime? registration_end_date { get; set; }
        public virtual DateTime? add_start_date { get; set; }
        public virtual DateTime? add_end_date { get; set; }
        public virtual DateTime? drop_start_date { get; set; }
        public virtual DateTime? drop_end_date { get; set; }
        public virtual DateTime? 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 string current_status { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
        public virtual DateTime timestamp { get; set; }
    }

    public partial class SectionsAvailableForStudentResponse
    {
        public SectionsAvailableForStudentResponse()
        {
            sectionsAvailable = new List<SectionAvailableForStudentResponse>{};
            messages = new List<string>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual bool notifyOfAcademicProbation { get; set; }
        public virtual List<SectionAvailableForStudentResponse> sectionsAvailable { get; set; }
        public virtual List<string> messages { get; set; }
    }

}

C# SectionsAvailableForStudentRequest 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/Available/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	transaction_uuid: String,
	reporting_term: String,
	online_only: False,
	oncampus_only: False,
	is_admin: False
}
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
		}
	},
	regent_id: 0,
	uuid: String,
	reporting_term: String,
	notifyOfAcademicProbation: False,
	sectionsAvailable: 
	[
		{
			uuid: String,
			studentSectionUUID: String,
			registered_amount: 0,
			is_full: False,
			is_too_late: False,
			is_too_early: False,
			is_audit: False,
			is_selected: False,
			is_registered: False,
			is_provisional: False,
			is_missing_requisites: False,
			is_completed: False,
			maximum_credit_hours: 0,
			maximum_audit_hours: 0,
			can_retake: False,
			is_credit_restricted: False,
			is_audit_restricted: False,
			is_oncampus_restricted_for_change: False,
			is_online_restricted_for_change: False,
			can_be_provisional: False,
			can_be_dropped: False,
			ruleMessages: 
			[
				String
			],
			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-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_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-01,
			registration_end_date: 0001-01-01,
			add_start_date: 0001-01-01,
			add_end_date: 0001-01-01,
			drop_start_date: 0001-01-01,
			drop_end_date: 0001-01-01,
			grading_end_date: 0001-01-01,
			term: String,
			reporting_term: String,
			reporting_year: 0,
			current_status: String,
			added_by: String,
			added_date: 0001-01-01,
			changed_by: String,
			changed_date: 0001-01-01,
			timestamp: 0001-01-01
		}
	],
	messages: 
	[
		String
	]
}