regis

<back to all web services

DropRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Drop/{reporting_term}
<?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 DropRegistrationResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $student_section_uuid=null,
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $section_code=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var float */
        public float $amount=0.0,
        /** @var bool|null */
        public ?bool $is_audit=null,
        /** @var bool|null */
        public ?bool $is_grade_final=null,
        /** @var bool|null */
        public ?bool $is_provisional=null,
        /** @var bool|null */
        public ?bool $is_selected_to_drop=null,
        /** @var float */
        public float $suggested_refund_percentage=0.0,
        /** @var float */
        public float $suggested_refund_amount=0.0,
        /** @var float */
        public float $balance_amount=0.0,
        /** @var float */
        public float $charge_amount=0.0,
        /** @var float */
        public float $credit_amount=0.0,
        /** @var string|null */
        public ?string $description=null,
        /** @var string|null */
        public ?string $additional_rate_description=null,
        /** @var int|null */
        public ?int $additional_rate_id=null,
        /** @var float|null */
        public ?float $additional_rate_amount=null,
        /** @var float|null */
        public ?float $additional_rate_suggested_refund_percentage=null,
        /** @var float|null */
        public ?float $additional_rate_suggested_refund_amount=null,
        /** @var string|null */
        public ?string $benefit_description=null,
        /** @var string|null */
        public ?string $second_benefit_description=null,
        /** @var int|null */
        public ?int $benefit_rate_id=null,
        /** @var float|null */
        public ?float $benefit_amount=null,
        /** @var float|null */
        public ?float $second_benefit_amount=null,
        /** @var int|null */
        public ?int $second_benefit_rate_id=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['student_section_uuid'])) $this->student_section_uuid = $o['student_section_uuid'];
        if (isset($o['course_name'])) $this->course_name = $o['course_name'];
        if (isset($o['section_code'])) $this->section_code = $o['section_code'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['amount'])) $this->amount = $o['amount'];
        if (isset($o['is_audit'])) $this->is_audit = $o['is_audit'];
        if (isset($o['is_grade_final'])) $this->is_grade_final = $o['is_grade_final'];
        if (isset($o['is_provisional'])) $this->is_provisional = $o['is_provisional'];
        if (isset($o['is_selected_to_drop'])) $this->is_selected_to_drop = $o['is_selected_to_drop'];
        if (isset($o['suggested_refund_percentage'])) $this->suggested_refund_percentage = $o['suggested_refund_percentage'];
        if (isset($o['suggested_refund_amount'])) $this->suggested_refund_amount = $o['suggested_refund_amount'];
        if (isset($o['balance_amount'])) $this->balance_amount = $o['balance_amount'];
        if (isset($o['charge_amount'])) $this->charge_amount = $o['charge_amount'];
        if (isset($o['credit_amount'])) $this->credit_amount = $o['credit_amount'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['additional_rate_description'])) $this->additional_rate_description = $o['additional_rate_description'];
        if (isset($o['additional_rate_id'])) $this->additional_rate_id = $o['additional_rate_id'];
        if (isset($o['additional_rate_amount'])) $this->additional_rate_amount = $o['additional_rate_amount'];
        if (isset($o['additional_rate_suggested_refund_percentage'])) $this->additional_rate_suggested_refund_percentage = $o['additional_rate_suggested_refund_percentage'];
        if (isset($o['additional_rate_suggested_refund_amount'])) $this->additional_rate_suggested_refund_amount = $o['additional_rate_suggested_refund_amount'];
        if (isset($o['benefit_description'])) $this->benefit_description = $o['benefit_description'];
        if (isset($o['second_benefit_description'])) $this->second_benefit_description = $o['second_benefit_description'];
        if (isset($o['benefit_rate_id'])) $this->benefit_rate_id = $o['benefit_rate_id'];
        if (isset($o['benefit_amount'])) $this->benefit_amount = $o['benefit_amount'];
        if (isset($o['second_benefit_amount'])) $this->second_benefit_amount = $o['second_benefit_amount'];
        if (isset($o['second_benefit_rate_id'])) $this->second_benefit_rate_id = $o['second_benefit_rate_id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->student_section_uuid)) $o['student_section_uuid'] = $this->student_section_uuid;
        if (isset($this->course_name)) $o['course_name'] = $this->course_name;
        if (isset($this->section_code)) $o['section_code'] = $this->section_code;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->amount)) $o['amount'] = $this->amount;
        if (isset($this->is_audit)) $o['is_audit'] = $this->is_audit;
        if (isset($this->is_grade_final)) $o['is_grade_final'] = $this->is_grade_final;
        if (isset($this->is_provisional)) $o['is_provisional'] = $this->is_provisional;
        if (isset($this->is_selected_to_drop)) $o['is_selected_to_drop'] = $this->is_selected_to_drop;
        if (isset($this->suggested_refund_percentage)) $o['suggested_refund_percentage'] = $this->suggested_refund_percentage;
        if (isset($this->suggested_refund_amount)) $o['suggested_refund_amount'] = $this->suggested_refund_amount;
        if (isset($this->balance_amount)) $o['balance_amount'] = $this->balance_amount;
        if (isset($this->charge_amount)) $o['charge_amount'] = $this->charge_amount;
        if (isset($this->credit_amount)) $o['credit_amount'] = $this->credit_amount;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->additional_rate_description)) $o['additional_rate_description'] = $this->additional_rate_description;
        if (isset($this->additional_rate_id)) $o['additional_rate_id'] = $this->additional_rate_id;
        if (isset($this->additional_rate_amount)) $o['additional_rate_amount'] = $this->additional_rate_amount;
        if (isset($this->additional_rate_suggested_refund_percentage)) $o['additional_rate_suggested_refund_percentage'] = $this->additional_rate_suggested_refund_percentage;
        if (isset($this->additional_rate_suggested_refund_amount)) $o['additional_rate_suggested_refund_amount'] = $this->additional_rate_suggested_refund_amount;
        if (isset($this->benefit_description)) $o['benefit_description'] = $this->benefit_description;
        if (isset($this->second_benefit_description)) $o['second_benefit_description'] = $this->second_benefit_description;
        if (isset($this->benefit_rate_id)) $o['benefit_rate_id'] = $this->benefit_rate_id;
        if (isset($this->benefit_amount)) $o['benefit_amount'] = $this->benefit_amount;
        if (isset($this->second_benefit_amount)) $o['second_benefit_amount'] = $this->second_benefit_amount;
        if (isset($this->second_benefit_rate_id)) $o['second_benefit_rate_id'] = $this->second_benefit_rate_id;
        return empty($o) ? new class(){} : $o;
    }
}

class InvoiceItemBalanceResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $rate_id=0,
        /** @var string|null */
        public ?string $rate_code=null,
        /** @var string|null */
        public ?string $rate_description=null,
        /** @var float */
        public float $balance_amount=0.0,
        /** @var float */
        public float $charge_amount=0.0,
        /** @var float */
        public float $credit_amount=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['rate_id'])) $this->rate_id = $o['rate_id'];
        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['balance_amount'])) $this->balance_amount = $o['balance_amount'];
        if (isset($o['charge_amount'])) $this->charge_amount = $o['charge_amount'];
        if (isset($o['credit_amount'])) $this->credit_amount = $o['credit_amount'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->rate_id)) $o['rate_id'] = $this->rate_id;
        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->balance_amount)) $o['balance_amount'] = $this->balance_amount;
        if (isset($this->charge_amount)) $o['charge_amount'] = $this->charge_amount;
        if (isset($this->credit_amount)) $o['credit_amount'] = $this->credit_amount;
        return empty($o) ? new class(){} : $o;
    }
}

class DropRegistrationsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $transaction_uuid=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var float */
        public float $suggested_drop_fee=0.0,
        /** @var bool|null */
        public ?bool $suggested_full_student_fee_refund=null,
        /** @var array<string>|null */
        public ?array $messages=null,
        /** @var array<DropRegistrationResponse>|null */
        public ?array $registrations=null,
        /** @var array<InvoiceItemBalanceResponse>|null */
        public ?array $invoiceItemBalances=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['transaction_uuid'])) $this->transaction_uuid = $o['transaction_uuid'];
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['suggested_drop_fee'])) $this->suggested_drop_fee = $o['suggested_drop_fee'];
        if (isset($o['suggested_full_student_fee_refund'])) $this->suggested_full_student_fee_refund = $o['suggested_full_student_fee_refund'];
        if (isset($o['messages'])) $this->messages = JsonConverters::fromArray('string', $o['messages']);
        if (isset($o['registrations'])) $this->registrations = JsonConverters::fromArray('DropRegistrationResponse', $o['registrations']);
        if (isset($o['invoiceItemBalances'])) $this->invoiceItemBalances = JsonConverters::fromArray('InvoiceItemBalanceResponse', $o['invoiceItemBalances']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->transaction_uuid)) $o['transaction_uuid'] = $this->transaction_uuid;
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->suggested_drop_fee)) $o['suggested_drop_fee'] = $this->suggested_drop_fee;
        if (isset($this->suggested_full_student_fee_refund)) $o['suggested_full_student_fee_refund'] = $this->suggested_full_student_fee_refund;
        if (isset($this->messages)) $o['messages'] = JsonConverters::toArray('string', $this->messages);
        if (isset($this->registrations)) $o['registrations'] = JsonConverters::toArray('DropRegistrationResponse', $this->registrations);
        if (isset($this->invoiceItemBalances)) $o['invoiceItemBalances'] = JsonConverters::toArray('InvoiceItemBalanceResponse', $this->invoiceItemBalances);
        return empty($o) ? new class(){} : $o;
    }
}

class DropRegistrationsRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var array<DropRegistrationResponse>|null */
        public ?array $registrations=null,
        /** @var DateTime|null */
        public ?DateTime $override_drop_date=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

    /** @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['registrations'])) $this->registrations = JsonConverters::fromArray('DropRegistrationResponse', $o['registrations']);
        if (isset($o['override_drop_date'])) $this->override_drop_date = JsonConverters::from('DateTime', $o['override_drop_date']);
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @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->registrations)) $o['registrations'] = JsonConverters::toArray('DropRegistrationResponse', $this->registrations);
        if (isset($this->override_drop_date)) $o['override_drop_date'] = JsonConverters::to('DateTime', $this->override_drop_date);
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP DropRegistrationsRequest 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 /Registration/{uuid}/Drop/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DropRegistrationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <override_drop_date>0001-01-01T00:00:00</override_drop_date>
  <registrations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
    <d2p1:DropRegistrationResponse>
      <d2p1:additional_rate_amount>0</d2p1:additional_rate_amount>
      <d2p1:additional_rate_description>String</d2p1:additional_rate_description>
      <d2p1:additional_rate_id>0</d2p1:additional_rate_id>
      <d2p1:additional_rate_suggested_refund_amount>0</d2p1:additional_rate_suggested_refund_amount>
      <d2p1:additional_rate_suggested_refund_percentage>0</d2p1:additional_rate_suggested_refund_percentage>
      <d2p1:amount>0</d2p1:amount>
      <d2p1:balance_amount>0</d2p1:balance_amount>
      <d2p1:benefit_amount>0</d2p1:benefit_amount>
      <d2p1:benefit_description>String</d2p1:benefit_description>
      <d2p1:benefit_rate_id>0</d2p1:benefit_rate_id>
      <d2p1:charge_amount>0</d2p1:charge_amount>
      <d2p1:course_name>String</d2p1:course_name>
      <d2p1:credit_amount>0</d2p1:credit_amount>
      <d2p1:description>String</d2p1:description>
      <d2p1:is_audit>false</d2p1:is_audit>
      <d2p1:is_grade_final>false</d2p1:is_grade_final>
      <d2p1:is_provisional>false</d2p1:is_provisional>
      <d2p1:is_selected_to_drop>false</d2p1:is_selected_to_drop>
      <d2p1:second_benefit_amount>0</d2p1:second_benefit_amount>
      <d2p1:second_benefit_description>String</d2p1:second_benefit_description>
      <d2p1:second_benefit_rate_id>0</d2p1:second_benefit_rate_id>
      <d2p1:section_code>String</d2p1:section_code>
      <d2p1:student_section_uuid>String</d2p1:student_section_uuid>
      <d2p1:suggested_refund_amount>0</d2p1:suggested_refund_amount>
      <d2p1:suggested_refund_percentage>0</d2p1:suggested_refund_percentage>
      <d2p1:term>String</d2p1:term>
      <d2p1:title>String</d2p1:title>
    </d2p1:DropRegistrationResponse>
  </registrations>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</DropRegistrationsRequest>

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

<DropRegistrationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <invoiceItemBalances>
    <InvoiceItemBalanceResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <balance_amount>0</balance_amount>
      <charge_amount>0</charge_amount>
      <credit_amount>0</credit_amount>
      <rate_code>String</rate_code>
      <rate_description>String</rate_description>
      <rate_id>0</rate_id>
    </InvoiceItemBalanceResponse>
  </invoiceItemBalances>
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <regent_id>0</regent_id>
  <registrations>
    <DropRegistrationResponse>
      <additional_rate_amount>0</additional_rate_amount>
      <additional_rate_description>String</additional_rate_description>
      <additional_rate_id>0</additional_rate_id>
      <additional_rate_suggested_refund_amount>0</additional_rate_suggested_refund_amount>
      <additional_rate_suggested_refund_percentage>0</additional_rate_suggested_refund_percentage>
      <amount>0</amount>
      <balance_amount>0</balance_amount>
      <benefit_amount>0</benefit_amount>
      <benefit_description>String</benefit_description>
      <benefit_rate_id>0</benefit_rate_id>
      <charge_amount>0</charge_amount>
      <course_name>String</course_name>
      <credit_amount>0</credit_amount>
      <description>String</description>
      <is_audit>false</is_audit>
      <is_grade_final>false</is_grade_final>
      <is_provisional>false</is_provisional>
      <is_selected_to_drop>false</is_selected_to_drop>
      <second_benefit_amount>0</second_benefit_amount>
      <second_benefit_description>String</second_benefit_description>
      <second_benefit_rate_id>0</second_benefit_rate_id>
      <section_code>String</section_code>
      <student_section_uuid>String</student_section_uuid>
      <suggested_refund_amount>0</suggested_refund_amount>
      <suggested_refund_percentage>0</suggested_refund_percentage>
      <term>String</term>
      <title>String</title>
    </DropRegistrationResponse>
  </registrations>
  <reporting_term>String</reporting_term>
  <suggested_drop_fee>0</suggested_drop_fee>
  <suggested_full_student_fee_refund>false</suggested_full_student_fee_refund>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</DropRegistrationsResponse>