regis

<back to all web services

RegistrationChangeSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Change/{uuid}/Term/{reporting_term}/Submit
<?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 RegistrationChangeSubmitRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $transaction_uuid=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var array<int>|null */
        public ?array $rates_opted_in=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var bool|null */
        public ?bool $is_audit=null,
        /** @var bool|null */
        public ?bool $is_oncampus=null,
        /** @var bool|null */
        public ?bool $is_online=null,
        /** @var float */
        public float $amount=0.0,
        /** @var string|null */
        public ?string $section_uuid=null,
        /** @var bool|null */
        public ?bool $appliedForSpousalAuditBenefit=null,
        /** @var bool|null */
        public ?bool $appliedForSpousalCreditBenefit=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['transaction_uuid'])) $this->transaction_uuid = $o['transaction_uuid'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['rates_opted_in'])) $this->rates_opted_in = JsonConverters::fromArray('int', $o['rates_opted_in']);
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
        if (isset($o['is_audit'])) $this->is_audit = $o['is_audit'];
        if (isset($o['is_oncampus'])) $this->is_oncampus = $o['is_oncampus'];
        if (isset($o['is_online'])) $this->is_online = $o['is_online'];
        if (isset($o['amount'])) $this->amount = $o['amount'];
        if (isset($o['section_uuid'])) $this->section_uuid = $o['section_uuid'];
        if (isset($o['appliedForSpousalAuditBenefit'])) $this->appliedForSpousalAuditBenefit = $o['appliedForSpousalAuditBenefit'];
        if (isset($o['appliedForSpousalCreditBenefit'])) $this->appliedForSpousalCreditBenefit = $o['appliedForSpousalCreditBenefit'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->transaction_uuid)) $o['transaction_uuid'] = $this->transaction_uuid;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->rates_opted_in)) $o['rates_opted_in'] = JsonConverters::toArray('int', $this->rates_opted_in);
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        if (isset($this->is_audit)) $o['is_audit'] = $this->is_audit;
        if (isset($this->is_oncampus)) $o['is_oncampus'] = $this->is_oncampus;
        if (isset($this->is_online)) $o['is_online'] = $this->is_online;
        if (isset($this->amount)) $o['amount'] = $this->amount;
        if (isset($this->section_uuid)) $o['section_uuid'] = $this->section_uuid;
        if (isset($this->appliedForSpousalAuditBenefit)) $o['appliedForSpousalAuditBenefit'] = $this->appliedForSpousalAuditBenefit;
        if (isset($this->appliedForSpousalCreditBenefit)) $o['appliedForSpousalCreditBenefit'] = $this->appliedForSpousalCreditBenefit;
        return empty($o) ? new class(){} : $o;
    }
}

PHP RegistrationChangeSubmitRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Registration/Change/{uuid}/Term/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"transaction_uuid":"String","uuid":"String","reporting_term":"String","rates_opted_in":[0],"authorizing_uuid":"String","is_audit":false,"is_oncampus":false,"is_online":false,"amount":0,"section_uuid":"String","appliedForSpousalAuditBenefit":false,"appliedForSpousalCreditBenefit":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}