regis

FinancialAidBudgetUpdateRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/FinancialAid/Awards/{reporting_term}/Update

<?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 FinancialAidBudgetUpdateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var array<string,float>|null */
        public ?array $award_budgets=null,
        /** @var bool|null */
        public ?bool $save_for_all_similar_future_terms=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['award_budgets'])) $this->award_budgets = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['int','float']), $o['award_budgets']);
        if (isset($o['save_for_all_similar_future_terms'])) $this->save_for_all_similar_future_terms = $o['save_for_all_similar_future_terms'];
    }
    
    /** @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->award_budgets)) $o['award_budgets'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['int','float']), $this->award_budgets);
        if (isset($this->save_for_all_similar_future_terms)) $o['save_for_all_similar_future_terms'] = $this->save_for_all_similar_future_terms;
        return empty($o) ? new class(){} : $o;
    }
}

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

{
	authorizing_uuid: String,
	reporting_term: String,
	award_budgets: 
	{
		0: 0
	},
	save_for_all_similar_future_terms: False
}

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
	}
}