| Required permission: | ReadSections |
| POST | /Section/Search |
|---|
<?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 SectionSearchRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $term=null,
/** @var string|null */
public ?string $course_name=null,
/** @var string|null */
public ?string $title=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['term'])) $this->term = $o['term'];
if (isset($o['course_name'])) $this->course_name = $o['course_name'];
if (isset($o['title'])) $this->title = $o['title'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->term)) $o['term'] = $this->term;
if (isset($this->course_name)) $o['course_name'] = $this->course_name;
if (isset($this->title)) $o['title'] = $this->title;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Section/Search HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SectionSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<course_name>String</course_name>
<term>String</term>
<title>String</title>
</SectionSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfSectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
<SectionResponse>
<ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:Message>String</d3p1:Message>
<d3p1:StackTrace>String</d3p1:StackTrace>
<d3p1:Errors>
<d3p1:ResponseError>
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:FieldName>String</d3p1:FieldName>
<d3p1:Message>String</d3p1:Message>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
</d3p1:ResponseError>
</d3p1:Errors>
<d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d3p1:Meta>
</ResponseStatus>
<add_end_date>0001-01-01T00:00:00</add_end_date>
<add_start_date>0001-01-01T00:00:00</add_start_date>
<added_by>String</added_by>
<added_date>0001-01-01T00:00:00</added_date>
<additional_fee_amount>0</additional_fee_amount>
<audit_amounts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:decimal>0</d3p1:decimal>
</audit_amounts>
<audits_long_name>String</audits_long_name>
<audits_short_name>String</audits_short_name>
<capacity>0</capacity>
<changed_by>String</changed_by>
<changed_date>0001-01-01T00:00:00</changed_date>
<corequisites>String</corequisites>
<course_description>String</course_description>
<course_name>String</course_name>
<course_short_title>String</course_short_title>
<course_title>String</course_title>
<credit_amounts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:decimal>0</d3p1:decimal>
</credit_amounts>
<credits_long_name>String</credits_long_name>
<credits_short_name>String</credits_short_name>
<crosslist_course_name>String</crosslist_course_name>
<crosslist_description>String</crosslist_description>
<crosslist_grades_received>0</crosslist_grades_received>
<crosslist_registered_students>0</crosslist_registered_students>
<current_status>String</current_status>
<distance_ed_materials>String</distance_ed_materials>
<drop_end_date>0001-01-01T00:00:00</drop_end_date>
<drop_start_date>0001-01-01T00:00:00</drop_start_date>
<end_date>0001-01-01T00:00:00</end_date>
<end_times xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</end_times>
<first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
<flat_fee_amount>0</flat_fee_amount>
<grades_received>0</grades_received>
<grading_end_date>0001-01-01T00:00:00</grading_end_date>
<has_special_requirements>false</has_special_requirements>
<instructors>
<InstructorResponse>
<ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types">
<d5p1:ErrorCode>String</d5p1:ErrorCode>
<d5p1:Message>String</d5p1:Message>
<d5p1:StackTrace>String</d5p1:StackTrace>
<d5p1:Errors>
<d5p1:ResponseError>
<d5p1:ErrorCode>String</d5p1:ErrorCode>
<d5p1:FieldName>String</d5p1:FieldName>
<d5p1:Message>String</d5p1:Message>
<d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>String</d8p1:Key>
<d8p1:Value>String</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d5p1:Meta>
</d5p1:ResponseError>
</d5p1:Errors>
<d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d5p1:Meta>
</ResponseStatus>
<email>String</email>
<first_name>String</first_name>
<full_name>String</full_name>
<image_base64>String</image_base64>
<last_name>String</last_name>
<preferred_name>String</preferred_name>
<regent_id>0</regent_id>
<regent_login>String</regent_login>
</InstructorResponse>
</instructors>
<is_evening>false</is_evening>
<is_online_only>false</is_online_only>
<is_unlisted>false</is_unlisted>
<is_waitlist>false</is_waitlist>
<is_weekday>false</is_weekday>
<is_weekend>false</is_weekend>
<last_meeting_date>0001-01-01T00:00:00</last_meeting_date>
<location_long_name>String</location_long_name>
<meeting_days>String</meeting_days>
<one_audit>0</one_audit>
<one_credit>0</one_credit>
<prerequisites>String</prerequisites>
<registered_students>0</registered_students>
<registration_end_date>0001-01-01T00:00:00</registration_end_date>
<registration_start_date>0001-01-01T00:00:00</registration_start_date>
<reporting_term>String</reporting_term>
<reporting_year>0</reporting_year>
<required_documents>
<DocumentResponse>
<code>String</code>
<document_description>String</document_description>
<document_name>String</document_name>
</DocumentResponse>
</required_documents>
<room>String</room>
<secUUID>String</secUUID>
<section_code>String</section_code>
<special_requirements>String</special_requirements>
<start_date>0001-01-01T00:00:00</start_date>
<start_times xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</start_times>
<term>String</term>
<three_audit_plus>0</three_audit_plus>
<three_credit_plus>0</three_credit_plus>
<timestamp>0001-01-01T00:00:00</timestamp>
<two_audit>0</two_audit>
<two_credit>0</two_credit>
</SectionResponse>
</ArrayOfSectionResponse>