regis

RateBalanceReportRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/registration/rate-balance-report

<?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 RateBalanceReportRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $year=0,
        /** @var string|null */
        public ?string $rate_code=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

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

PHP RateBalanceReportRequest DTOs

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

HTTP + XML

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

POST /registration/rate-balance-report HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RateBalanceReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <rate_code>String</rate_code>
  <year>0</year>
</RateBalanceReportRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfRateBalanceReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <RateBalanceReportResponse>
    <fall_audit_hours>0</fall_audit_hours>
    <fall_balance>0</fall_balance>
    <fall_credit_hours>0</fall_credit_hours>
    <fall_invoices>
      <RateBalanceInvoiceResponse>
        <added_date>0001-01-01T00:00:00</added_date>
        <charge>0</charge>
        <credit>0</credit>
      </RateBalanceInvoiceResponse>
    </fall_invoices>
    <regent_id>0</regent_id>
    <student_name>String</student_name>
    <student_uuid>String</student_uuid>
    <summer_audit_hours>0</summer_audit_hours>
    <summer_balance>0</summer_balance>
    <summer_credit_hours>0</summer_credit_hours>
    <summer_invoices>
      <RateBalanceInvoiceResponse>
        <added_date>0001-01-01T00:00:00</added_date>
        <charge>0</charge>
        <credit>0</credit>
      </RateBalanceInvoiceResponse>
    </summer_invoices>
    <winter_audit_hours>0</winter_audit_hours>
    <winter_balance>0</winter_balance>
    <winter_credit_hours>0</winter_credit_hours>
    <winter_invoices>
      <RateBalanceInvoiceResponse>
        <added_date>0001-01-01T00:00:00</added_date>
        <charge>0</charge>
        <credit>0</credit>
      </RateBalanceInvoiceResponse>
    </winter_invoices>
  </RateBalanceReportResponse>
</ArrayOfRateBalanceReportResponse>