regis

<back to all web services

AddRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Add/{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 AddRegistrationWithBenefitRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $student_section_uuid=null,
        /** @var string|null */
        public ?string $description=null,
        /** @var float */
        public float $amount=0.0,
        /** @var float */
        public float $charge=0.0,
        /** @var bool|null */
        public ?bool $is_audit=null,
        /** @var int|null */
        public ?int $benefit_id=null,
        /** @var float|null */
        public ?float $benefit_amount=null,
        /** @var int|null */
        public ?int $second_benefit_id=null,
        /** @var float|null */
        public ?float $second_benefit_amount=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['description'])) $this->description = $o['description'];
        if (isset($o['amount'])) $this->amount = $o['amount'];
        if (isset($o['charge'])) $this->charge = $o['charge'];
        if (isset($o['is_audit'])) $this->is_audit = $o['is_audit'];
        if (isset($o['benefit_id'])) $this->benefit_id = $o['benefit_id'];
        if (isset($o['benefit_amount'])) $this->benefit_amount = $o['benefit_amount'];
        if (isset($o['second_benefit_id'])) $this->second_benefit_id = $o['second_benefit_id'];
        if (isset($o['second_benefit_amount'])) $this->second_benefit_amount = $o['second_benefit_amount'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->student_section_uuid)) $o['student_section_uuid'] = $this->student_section_uuid;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->amount)) $o['amount'] = $this->amount;
        if (isset($this->charge)) $o['charge'] = $this->charge;
        if (isset($this->is_audit)) $o['is_audit'] = $this->is_audit;
        if (isset($this->benefit_id)) $o['benefit_id'] = $this->benefit_id;
        if (isset($this->benefit_amount)) $o['benefit_amount'] = $this->benefit_amount;
        if (isset($this->second_benefit_id)) $o['second_benefit_id'] = $this->second_benefit_id;
        if (isset($this->second_benefit_amount)) $o['second_benefit_amount'] = $this->second_benefit_amount;
        return empty($o) ? new class(){} : $o;
    }
}

class AddRegistrationsAdditionalChargeSubmitRequest 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
    ) {
    }

    /** @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'];
    }
    
    /** @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;
        return empty($o) ? new class(){} : $o;
    }
}

class AddRegistrationsSubmitRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $transaction_uuid=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var string|null */
        public ?string $description=null,
        /** @var bool|null */
        public ?bool $email_student=null,
        /** @var array<AddRegistrationWithBenefitRequest>|null */
        public ?array $registrations=null,
        /** @var array<AddRegistrationsAdditionalChargeSubmitRequest>|null */
        public ?array $additional_term_charges=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['transaction_uuid'])) $this->transaction_uuid = $o['transaction_uuid'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['email_student'])) $this->email_student = $o['email_student'];
        if (isset($o['registrations'])) $this->registrations = JsonConverters::fromArray('AddRegistrationWithBenefitRequest', $o['registrations']);
        if (isset($o['additional_term_charges'])) $this->additional_term_charges = JsonConverters::fromArray('AddRegistrationsAdditionalChargeSubmitRequest', $o['additional_term_charges']);
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->transaction_uuid)) $o['transaction_uuid'] = $this->transaction_uuid;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->email_student)) $o['email_student'] = $this->email_student;
        if (isset($this->registrations)) $o['registrations'] = JsonConverters::toArray('AddRegistrationWithBenefitRequest', $this->registrations);
        if (isset($this->additional_term_charges)) $o['additional_term_charges'] = JsonConverters::toArray('AddRegistrationsAdditionalChargeSubmitRequest', $this->additional_term_charges);
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

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

<AddRegistrationsSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <additional_term_charges>
    <AddRegistrationsAdditionalChargeSubmitRequest>
      <charge>0</charge>
      <credit>0</credit>
      <description>String</description>
      <rate_id>0</rate_id>
    </AddRegistrationsAdditionalChargeSubmitRequest>
  </additional_term_charges>
  <authorizing_uuid>String</authorizing_uuid>
  <description>String</description>
  <email_student>false</email_student>
  <registrations>
    <AddRegistrationWithBenefitRequest>
      <amount>0</amount>
      <benefit_amount>0</benefit_amount>
      <benefit_id>0</benefit_id>
      <charge>0</charge>
      <description>String</description>
      <is_audit>false</is_audit>
      <second_benefit_amount>0</second_benefit_amount>
      <second_benefit_id>0</second_benefit_id>
      <student_section_uuid>String</student_section_uuid>
    </AddRegistrationWithBenefitRequest>
  </registrations>
  <reporting_term>String</reporting_term>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</AddRegistrationsSubmitRequest>

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>