regis

DropRegistrationsForBalanceOwingRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Registration/{reporting_term}/DropForBalanceOwing

<?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 DropRegistrationsForBalanceOwingRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var bool|null */
        public ?bool $is_preview_only=null,
        /** @var DateTime|null */
        public ?DateTime $override_drop_date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['is_preview_only'])) $this->is_preview_only = $o['is_preview_only'];
        if (isset($o['override_drop_date'])) $this->override_drop_date = JsonConverters::from('DateTime', $o['override_drop_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->is_preview_only)) $o['is_preview_only'] = $this->is_preview_only;
        if (isset($this->override_drop_date)) $o['override_drop_date'] = JsonConverters::to('DateTime', $this->override_drop_date);
        return empty($o) ? new class(){} : $o;
    }
}

PHP DropRegistrationsForBalanceOwingRequest 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/{reporting_term}/DropForBalanceOwing HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	authorizing_uuid: String,
	reporting_term: String,
	is_preview_only: False,
	override_drop_date: 0001-01-01
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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,
		first_name: String,
		last_name: String,
		uuid: String,
		amount_owing: 0,
		reporting_term: String,
		active_financial_restrictions: String,
		sections_dropped: 
		[
			{
				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
			}
		]
	}
]