regis

FinanceAdjustmentSubmitRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/{uuid}/Adjustment/{reporting_term}/Submit

<?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 FinanceAdjustmentRateSubmitRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $rate_id=0,
        /** @var string|null */
        public ?string $description=null,
        /** @var float */
        public float $charge=0.0,
        /** @var float */
        public float $credit=0.0,
        /** @var string|null */
        public ?string $custom_gl=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['rate_id'])) $this->rate_id = $o['rate_id'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['charge'])) $this->charge = $o['charge'];
        if (isset($o['credit'])) $this->credit = $o['credit'];
        if (isset($o['custom_gl'])) $this->custom_gl = $o['custom_gl'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->rate_id)) $o['rate_id'] = $this->rate_id;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->charge)) $o['charge'] = $this->charge;
        if (isset($this->credit)) $o['credit'] = $this->credit;
        if (isset($this->custom_gl)) $o['custom_gl'] = $this->custom_gl;
        return empty($o) ? new class(){} : $o;
    }
}

class FinanceAdjustmentSubmitRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var array<FinanceAdjustmentRateSubmitRequest>|null */
        public ?array $rates=null,
        /** @var string|null */
        public ?string $description=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var bool|null */
        public ?bool $is_financial_aid=null,
        /** @var DateTime */
        public DateTime $added_date=new DateTime()
    ) {
    }

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

PHP FinanceAdjustmentSubmitRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/{uuid}/Adjustment/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinanceAdjustmentSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <added_date>0001-01-01T00:00:00</added_date>
  <authorizing_uuid>String</authorizing_uuid>
  <description>String</description>
  <is_financial_aid>false</is_financial_aid>
  <rates>
    <FinanceAdjustmentRateSubmitRequest>
      <charge>0</charge>
      <credit>0</credit>
      <custom_gl>String</custom_gl>
      <description>String</description>
      <rate_id>0</rate_id>
    </FinanceAdjustmentRateSubmitRequest>
  </rates>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</FinanceAdjustmentSubmitRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>