regis

<back to all web services

SectionRefundScheduleCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/{reporting_term}/{section_uuid}/RefundSchedule/Create
<?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 SectionRefundScheduleCreateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $section_uuid=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var string|null */
        public ?string $rate_code=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var float */
        public float $percentage=0.0,
        /** @var DateTime */
        public DateTime $start_date=new DateTime(),
        /** @var DateTime */
        public DateTime $end_date=new DateTime()
    ) {
    }

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

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

{
	section_uuid: String,
	authorizing_uuid: String,
	rate_code: String,
	reporting_term: String,
	percentage: 0,
	start_date: 0001-01-01,
	end_date: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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