regis

<back to all web services

DropRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Drop/{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 DropRegistrationSubmitRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $student_section_uuid=null,
        /** @var float */
        public float $tuition_refund_amount=0.0,
        /** @var string|null */
        public ?string $description=null,
        /** @var int|null */
        public ?int $additional_rate_id=null,
        /** @var float|null */
        public ?float $additional_rate_amount=null,
        /** @var int|null */
        public ?int $benefit_rate_id=null,
        /** @var int|null */
        public ?int $second_benefit_rate_id=null,
        /** @var float|null */
        public ?float $benefit_charge_amount=null,
        /** @var float|null */
        public ?float $second_benefit_charge_amount=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['student_section_uuid'])) $this->student_section_uuid = $o['student_section_uuid'];
        if (isset($o['tuition_refund_amount'])) $this->tuition_refund_amount = $o['tuition_refund_amount'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['additional_rate_id'])) $this->additional_rate_id = $o['additional_rate_id'];
        if (isset($o['additional_rate_amount'])) $this->additional_rate_amount = $o['additional_rate_amount'];
        if (isset($o['benefit_rate_id'])) $this->benefit_rate_id = $o['benefit_rate_id'];
        if (isset($o['second_benefit_rate_id'])) $this->second_benefit_rate_id = $o['second_benefit_rate_id'];
        if (isset($o['benefit_charge_amount'])) $this->benefit_charge_amount = $o['benefit_charge_amount'];
        if (isset($o['second_benefit_charge_amount'])) $this->second_benefit_charge_amount = $o['second_benefit_charge_amount'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->student_section_uuid)) $o['student_section_uuid'] = $this->student_section_uuid;
        if (isset($this->tuition_refund_amount)) $o['tuition_refund_amount'] = $this->tuition_refund_amount;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->additional_rate_id)) $o['additional_rate_id'] = $this->additional_rate_id;
        if (isset($this->additional_rate_amount)) $o['additional_rate_amount'] = $this->additional_rate_amount;
        if (isset($this->benefit_rate_id)) $o['benefit_rate_id'] = $this->benefit_rate_id;
        if (isset($this->second_benefit_rate_id)) $o['second_benefit_rate_id'] = $this->second_benefit_rate_id;
        if (isset($this->benefit_charge_amount)) $o['benefit_charge_amount'] = $this->benefit_charge_amount;
        if (isset($this->second_benefit_charge_amount)) $o['second_benefit_charge_amount'] = $this->second_benefit_charge_amount;
        return empty($o) ? new class(){} : $o;
    }
}

class DropRegistrationsSubmitRequest 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<DropRegistrationSubmitRequest>|null */
        public ?array $registrations=null,
        /** @var string|null */
        public ?string $description=null,
        /** @var float|null */
        public ?float $drop_fee=null,
        /** @var string|null */
        public ?string $drop_description=null,
        /** @var bool|null */
        public ?bool $refund_student_fees=null,
        /** @var string|null */
        public ?string $authorizing_uuid=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['registrations'])) $this->registrations = JsonConverters::fromArray('DropRegistrationSubmitRequest', $o['registrations']);
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['drop_fee'])) $this->drop_fee = $o['drop_fee'];
        if (isset($o['drop_description'])) $this->drop_description = $o['drop_description'];
        if (isset($o['refund_student_fees'])) $this->refund_student_fees = $o['refund_student_fees'];
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @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->registrations)) $o['registrations'] = JsonConverters::toArray('DropRegistrationSubmitRequest', $this->registrations);
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->drop_fee)) $o['drop_fee'] = $this->drop_fee;
        if (isset($this->drop_description)) $o['drop_description'] = $this->drop_description;
        if (isset($this->refund_student_fees)) $o['refund_student_fees'] = $this->refund_student_fees;
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP DropRegistrationsSubmitRequest 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 /Registration/{uuid}/Drop/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"transaction_uuid":"String","uuid":"String","reporting_term":"String","registrations":[{"student_section_uuid":"String","tuition_refund_amount":0,"description":"String","additional_rate_id":0,"additional_rate_amount":0,"benefit_rate_id":0,"second_benefit_rate_id":0,"benefit_charge_amount":0,"second_benefit_charge_amount":0}],"description":"String","drop_fee":0,"drop_description":"String","refund_student_fees":false,"authorizing_uuid":"String"}

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

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