regis

<back to all web services

SectionRateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/{reporting_term}/Rate/{section_rate_uuid}
<?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 SectionRateResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $secUUID=null,
        /** @var int */
        public int $section_id=0,
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $section_code=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var string|null */
        public ?string $rate_code=null,
        /** @var string|null */
        public ?string $rate_description=null,
        /** @var bool|null */
        public ?bool $is_override_credit_rate=null,
        /** @var bool|null */
        public ?bool $is_override_audit_rate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['secUUID'])) $this->secUUID = $o['secUUID'];
        if (isset($o['section_id'])) $this->section_id = $o['section_id'];
        if (isset($o['course_name'])) $this->course_name = $o['course_name'];
        if (isset($o['section_code'])) $this->section_code = $o['section_code'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['rate_code'])) $this->rate_code = $o['rate_code'];
        if (isset($o['rate_description'])) $this->rate_description = $o['rate_description'];
        if (isset($o['is_override_credit_rate'])) $this->is_override_credit_rate = $o['is_override_credit_rate'];
        if (isset($o['is_override_audit_rate'])) $this->is_override_audit_rate = $o['is_override_audit_rate'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->secUUID)) $o['secUUID'] = $this->secUUID;
        if (isset($this->section_id)) $o['section_id'] = $this->section_id;
        if (isset($this->course_name)) $o['course_name'] = $this->course_name;
        if (isset($this->section_code)) $o['section_code'] = $this->section_code;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->rate_code)) $o['rate_code'] = $this->rate_code;
        if (isset($this->rate_description)) $o['rate_description'] = $this->rate_description;
        if (isset($this->is_override_credit_rate)) $o['is_override_credit_rate'] = $this->is_override_credit_rate;
        if (isset($this->is_override_audit_rate)) $o['is_override_audit_rate'] = $this->is_override_audit_rate;
        return empty($o) ? new class(){} : $o;
    }
}

class SectionRateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var string|null */
        public ?string $section_rate_uuid=null
    ) {
    }

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

PHP SectionRateRequest DTOs

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

HTTP + CSV

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

POST /Sections/{reporting_term}/Rate/{section_rate_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String","section_rate_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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}