regis

SectionsLookupRequest

**Requires Authentication**
Required permission:	ReadSections

The following routes are available for this service:
POST	/Sections/Lookup/{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 SectionsLookupRequest 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;
    }
}

PHP SectionsLookupRequest 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/Lookup/{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
			}
		},
		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
	}
]