regis

<back to all web services

StudentAcademicCredentialsActiveRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentAcademicCredentials/Active
<?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 StudentAcademicCredentialResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $stac_uuid=null,
        /** @var int|null */
        public ?int $section_id=null,
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $section_code=null,
        /** @var string|null */
        public ?string $subject=null,
        /** @var int|null */
        public ?int $course_level=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var string|null */
        public ?string $pretty_title=null,
        /** @var string|null */
        public ?string $location=null,
        /** @var bool|null */
        public ?bool $is_audio=null,
        /** @var bool|null */
        public ?bool $is_oncampus=null,
        /** @var float|null */
        public ?float $credit_value=null,
        /** @var float|null */
        public ?float $audit_value=null,
        /** @var bool|null */
        public ?bool $is_audit=null,
        /** @var bool|null */
        public ?bool $is_pass_fail=null,
        /** @var string|null */
        public ?string $grade=null,
        /** @var bool|null */
        public ?bool $is_grade_final=null,
        /** @var float|null */
        public ?float $gpa_credits=null,
        /** @var float|null */
        public ?float $grade_points=null,
        /** @var string|null */
        public ?string $academic_level=null,
        /** @var string|null */
        public ?string $printed_comments=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var int|null */
        public ?int $reporting_year=null,
        /** @var string|null */
        public ?string $current_status=null,
        /** @var string|null */
        public ?string $added_by=null,
        /** @var DateTime|null */
        public ?DateTime $added_date=null,
        /** @var string|null */
        public ?string $changed_by=null,
        /** @var DateTime|null */
        public ?DateTime $changed_date=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['stac_uuid'])) $this->stac_uuid = $o['stac_uuid'];
        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['subject'])) $this->subject = $o['subject'];
        if (isset($o['course_level'])) $this->course_level = $o['course_level'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['pretty_title'])) $this->pretty_title = $o['pretty_title'];
        if (isset($o['location'])) $this->location = $o['location'];
        if (isset($o['is_audio'])) $this->is_audio = $o['is_audio'];
        if (isset($o['is_oncampus'])) $this->is_oncampus = $o['is_oncampus'];
        if (isset($o['credit_value'])) $this->credit_value = $o['credit_value'];
        if (isset($o['audit_value'])) $this->audit_value = $o['audit_value'];
        if (isset($o['is_audit'])) $this->is_audit = $o['is_audit'];
        if (isset($o['is_pass_fail'])) $this->is_pass_fail = $o['is_pass_fail'];
        if (isset($o['grade'])) $this->grade = $o['grade'];
        if (isset($o['is_grade_final'])) $this->is_grade_final = $o['is_grade_final'];
        if (isset($o['gpa_credits'])) $this->gpa_credits = $o['gpa_credits'];
        if (isset($o['grade_points'])) $this->grade_points = $o['grade_points'];
        if (isset($o['academic_level'])) $this->academic_level = $o['academic_level'];
        if (isset($o['printed_comments'])) $this->printed_comments = $o['printed_comments'];
        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['current_status'])) $this->current_status = $o['current_status'];
        if (isset($o['added_by'])) $this->added_by = $o['added_by'];
        if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
        if (isset($o['changed_by'])) $this->changed_by = $o['changed_by'];
        if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
    }
    
    /** @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->stac_uuid)) $o['stac_uuid'] = $this->stac_uuid;
        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->subject)) $o['subject'] = $this->subject;
        if (isset($this->course_level)) $o['course_level'] = $this->course_level;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->pretty_title)) $o['pretty_title'] = $this->pretty_title;
        if (isset($this->location)) $o['location'] = $this->location;
        if (isset($this->is_audio)) $o['is_audio'] = $this->is_audio;
        if (isset($this->is_oncampus)) $o['is_oncampus'] = $this->is_oncampus;
        if (isset($this->credit_value)) $o['credit_value'] = $this->credit_value;
        if (isset($this->audit_value)) $o['audit_value'] = $this->audit_value;
        if (isset($this->is_audit)) $o['is_audit'] = $this->is_audit;
        if (isset($this->is_pass_fail)) $o['is_pass_fail'] = $this->is_pass_fail;
        if (isset($this->grade)) $o['grade'] = $this->grade;
        if (isset($this->is_grade_final)) $o['is_grade_final'] = $this->is_grade_final;
        if (isset($this->gpa_credits)) $o['gpa_credits'] = $this->gpa_credits;
        if (isset($this->grade_points)) $o['grade_points'] = $this->grade_points;
        if (isset($this->academic_level)) $o['academic_level'] = $this->academic_level;
        if (isset($this->printed_comments)) $o['printed_comments'] = $this->printed_comments;
        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->current_status)) $o['current_status'] = $this->current_status;
        if (isset($this->added_by)) $o['added_by'] = $this->added_by;
        if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
        if (isset($this->changed_by)) $o['changed_by'] = $this->changed_by;
        if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
        return empty($o) ? new class(){} : $o;
    }
}

class StudentAcademicCredentialsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var array<StudentAcademicCredentialResponse>|null */
        public ?array $studentAcademicCredentials=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['studentAcademicCredentials'])) $this->studentAcademicCredentials = JsonConverters::fromArray('StudentAcademicCredentialResponse', $o['studentAcademicCredentials']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->studentAcademicCredentials)) $o['studentAcademicCredentials'] = JsonConverters::toArray('StudentAcademicCredentialResponse', $this->studentAcademicCredentials);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

PHP StudentAcademicCredentialsActiveRequest 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 /StudentAcademicCredentials/Active HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"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"}},"regent_id":0,"uuid":"String","studentAcademicCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stac_uuid":"String","section_id":0,"course_name":"String","section_code":"String","subject":"String","course_level":0,"title":"String","pretty_title":"String","location":"String","is_audio":false,"is_oncampus":false,"credit_value":0,"audit_value":0,"is_audit":false,"is_pass_fail":false,"grade":"String","is_grade_final":false,"gpa_credits":0,"grade_points":0,"academic_level":"String","printed_comments":"String","term":"String","reporting_term":"String","reporting_year":0,"current_status":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}]}