regis

TermRequest

**Requires Authentication**
Required permission:	ReadTerm

The following routes are available for this service:
POST	/Terms/{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 TermResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var int */
        public int $reporting_year=0,
        /** @var string|null */
        public ?string $description=null,
        /** @var DateTime|null */
        public ?DateTime $start_date=null,
        /** @var DateTime|null */
        public ?DateTime $end_date=null,
        /** @var DateTime|null */
        public ?DateTime $registration_start_date=null,
        /** @var DateTime|null */
        public ?DateTime $registration_end_date=null,
        /** @var DateTime|null */
        public ?DateTime $drop_start_date=null,
        /** @var DateTime|null */
        public ?DateTime $drop_end_date=null,
        /** @var DateTime|null */
        public ?DateTime $add_start_date=null,
        /** @var DateTime|null */
        public ?DateTime $add_end_date=null,
        /** @var DateTime|null */
        public ?DateTime $grading_end_date=null,
        /** @var int */
        public int $number_of_sections=0,
        /** @var int */
        public int $number_of_rates=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['reporting_year'])) $this->reporting_year = $o['reporting_year'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['start_date'])) $this->start_date = JsonConverters::from('DateTime', $o['start_date']);
        if (isset($o['end_date'])) $this->end_date = JsonConverters::from('DateTime', $o['end_date']);
        if (isset($o['registration_start_date'])) $this->registration_start_date = JsonConverters::from('DateTime', $o['registration_start_date']);
        if (isset($o['registration_end_date'])) $this->registration_end_date = JsonConverters::from('DateTime', $o['registration_end_date']);
        if (isset($o['drop_start_date'])) $this->drop_start_date = JsonConverters::from('DateTime', $o['drop_start_date']);
        if (isset($o['drop_end_date'])) $this->drop_end_date = JsonConverters::from('DateTime', $o['drop_end_date']);
        if (isset($o['add_start_date'])) $this->add_start_date = JsonConverters::from('DateTime', $o['add_start_date']);
        if (isset($o['add_end_date'])) $this->add_end_date = JsonConverters::from('DateTime', $o['add_end_date']);
        if (isset($o['grading_end_date'])) $this->grading_end_date = JsonConverters::from('DateTime', $o['grading_end_date']);
        if (isset($o['number_of_sections'])) $this->number_of_sections = $o['number_of_sections'];
        if (isset($o['number_of_rates'])) $this->number_of_rates = $o['number_of_rates'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->reporting_year)) $o['reporting_year'] = $this->reporting_year;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->start_date)) $o['start_date'] = JsonConverters::to('DateTime', $this->start_date);
        if (isset($this->end_date)) $o['end_date'] = JsonConverters::to('DateTime', $this->end_date);
        if (isset($this->registration_start_date)) $o['registration_start_date'] = JsonConverters::to('DateTime', $this->registration_start_date);
        if (isset($this->registration_end_date)) $o['registration_end_date'] = JsonConverters::to('DateTime', $this->registration_end_date);
        if (isset($this->drop_start_date)) $o['drop_start_date'] = JsonConverters::to('DateTime', $this->drop_start_date);
        if (isset($this->drop_end_date)) $o['drop_end_date'] = JsonConverters::to('DateTime', $this->drop_end_date);
        if (isset($this->add_start_date)) $o['add_start_date'] = JsonConverters::to('DateTime', $this->add_start_date);
        if (isset($this->add_end_date)) $o['add_end_date'] = JsonConverters::to('DateTime', $this->add_end_date);
        if (isset($this->grading_end_date)) $o['grading_end_date'] = JsonConverters::to('DateTime', $this->grading_end_date);
        if (isset($this->number_of_sections)) $o['number_of_sections'] = $this->number_of_sections;
        if (isset($this->number_of_rates)) $o['number_of_rates'] = $this->number_of_rates;
        return empty($o) ? new class(){} : $o;
    }
}

class TermRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $term=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['term'])) $this->term = $o['term'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->term)) $o['term'] = $this->term;
        return empty($o) ? new class(){} : $o;
    }
}

PHP TermRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Terms/{term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"term":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"term":"String","reporting_term":"String","reporting_year":0,"description":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","registration_start_date":"0001-01-01T00:00:00.0000000","registration_end_date":"0001-01-01T00:00:00.0000000","drop_start_date":"0001-01-01T00:00:00.0000000","drop_end_date":"0001-01-01T00:00:00.0000000","add_start_date":"0001-01-01T00:00:00.0000000","add_end_date":"0001-01-01T00:00:00.0000000","grading_end_date":"0001-01-01T00:00:00.0000000","number_of_sections":0,"number_of_rates":0}