regis

<back to all web services

RateUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Rates/{term}/{rate_code}/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 RateUpdateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var string|null */
        public ?string $rate_code=null,
        /** @var string|null */
        public ?string $rate_description=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var float|null */
        public ?float $charge=null,
        /** @var float|null */
        public ?float $credit=null,
        /** @var float|null */
        public ?float $percentage=null,
        /** @var float|null */
        public ?float $budget=null,
        /** @var bool|null */
        public ?bool $is_benefit=null,
        /** @var bool|null */
        public ?bool $is_financial_aid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        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['rate_description'])) $this->rate_description = $o['rate_description'];
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['charge'])) $this->charge = $o['charge'];
        if (isset($o['credit'])) $this->credit = $o['credit'];
        if (isset($o['percentage'])) $this->percentage = $o['percentage'];
        if (isset($o['budget'])) $this->budget = $o['budget'];
        if (isset($o['is_benefit'])) $this->is_benefit = $o['is_benefit'];
        if (isset($o['is_financial_aid'])) $this->is_financial_aid = $o['is_financial_aid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        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->rate_description)) $o['rate_description'] = $this->rate_description;
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->charge)) $o['charge'] = $this->charge;
        if (isset($this->credit)) $o['credit'] = $this->credit;
        if (isset($this->percentage)) $o['percentage'] = $this->percentage;
        if (isset($this->budget)) $o['budget'] = $this->budget;
        if (isset($this->is_benefit)) $o['is_benefit'] = $this->is_benefit;
        if (isset($this->is_financial_aid)) $o['is_financial_aid'] = $this->is_financial_aid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP RateUpdateRequest 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 /Rates/{term}/{rate_code}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RateUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <budget>0</budget>
  <charge>0</charge>
  <credit>0</credit>
  <is_benefit>false</is_benefit>
  <is_financial_aid>false</is_financial_aid>
  <percentage>0</percentage>
  <rate_code>String</rate_code>
  <rate_description>String</rate_description>
  <term>String</term>
</RateUpdateRequest>
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>