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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	year: 0,
	rate_code: String,
	authorizing_uuid: String
}

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

[
	{
		regent_id: 0,
		student_uuid: String,
		student_name: String,
		fall_balance: 0,
		winter_balance: 0,
		summer_balance: 0,
		fall_credit_hours: 0,
		fall_audit_hours: 0,
		winter_credit_hours: 0,
		winter_audit_hours: 0,
		summer_credit_hours: 0,
		summer_audit_hours: 0,
		fall_invoices: 
		[
			{
				added_date: 0001-01-01,
				charge: 0,
				credit: 0,
				balance: 0
			}
		],
		winter_invoices: 
		[
			{
				added_date: 0001-01-01,
				charge: 0,
				credit: 0,
				balance: 0
			}
		],
		summer_invoices: 
		[
			{
				added_date: 0001-01-01,
				charge: 0,
				credit: 0,
				balance: 0
			}
		],
		total_balance: 0
	}
]