regis

FinancialAidApplicationUpdateAwardsRequest

**Requires Authentication**
Required role:	REGISUserRole

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

<?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 FinancialAidApplicationUpdateAwardRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $award_code=null,
        /** @var string|null */
        public ?string $award_description=null,
        /** @var bool|null */
        public ?bool $is_awarded=null,
        /** @var bool|null */
        public ?bool $is_eligible=null,
        /** @var float|null */
        public ?float $award_amount=null,
        /** @var string|null */
        public ?string $comments=null,
        /** @var string|null */
        public ?string $term=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['award_code'])) $this->award_code = $o['award_code'];
        if (isset($o['award_description'])) $this->award_description = $o['award_description'];
        if (isset($o['is_awarded'])) $this->is_awarded = $o['is_awarded'];
        if (isset($o['is_eligible'])) $this->is_eligible = $o['is_eligible'];
        if (isset($o['award_amount'])) $this->award_amount = $o['award_amount'];
        if (isset($o['comments'])) $this->comments = $o['comments'];
        if (isset($o['term'])) $this->term = $o['term'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->award_code)) $o['award_code'] = $this->award_code;
        if (isset($this->award_description)) $o['award_description'] = $this->award_description;
        if (isset($this->is_awarded)) $o['is_awarded'] = $this->is_awarded;
        if (isset($this->is_eligible)) $o['is_eligible'] = $this->is_eligible;
        if (isset($this->award_amount)) $o['award_amount'] = $this->award_amount;
        if (isset($this->comments)) $o['comments'] = $this->comments;
        if (isset($this->term)) $o['term'] = $this->term;
        return empty($o) ? new class(){} : $o;
    }
}

class FinancialAidApplicationUpdateAwardsRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $application_uuid=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var array<FinancialAidApplicationUpdateAwardRequest>|null */
        public ?array $awards=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['application_uuid'])) $this->application_uuid = $o['application_uuid'];
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['awards'])) $this->awards = JsonConverters::fromArray('FinancialAidApplicationUpdateAwardRequest', $o['awards']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->application_uuid)) $o['application_uuid'] = $this->application_uuid;
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->awards)) $o['awards'] = JsonConverters::toArray('FinancialAidApplicationUpdateAwardRequest', $this->awards);
        return empty($o) ? new class(){} : $o;
    }
}

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

{
	application_uuid: String,
	authorizing_uuid: String,
	term: String,
	awards: 
	[
		{
			award_code: String,
			award_description: String,
			is_awarded: False,
			is_eligible: False,
			award_amount: 0,
			comments: String,
			term: String
		}
	]
}

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