regis

<back to all web services

FinancePaymentV4CreateIdRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/PaymentV4/CreateId
<?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 FinancePaymentV4CreateIdResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $payment_id=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['payment_id'])) $this->payment_id = $o['payment_id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->payment_id)) $o['payment_id'] = $this->payment_id;
        return empty($o) ? new class(){} : $o;
    }
}

class FinancePaymentV4CreateIdRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $department=null,
        /** @var string|null */
        public ?string $item=null,
        /** @var bool|null */
        public ?bool $is_mastercard=null,
        /** @var bool|null */
        public ?bool $is_visa=null,
        /** @var int */
        public int $regent_id=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['department'])) $this->department = $o['department'];
        if (isset($o['item'])) $this->item = $o['item'];
        if (isset($o['is_mastercard'])) $this->is_mastercard = $o['is_mastercard'];
        if (isset($o['is_visa'])) $this->is_visa = $o['is_visa'];
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->department)) $o['department'] = $this->department;
        if (isset($this->item)) $o['item'] = $this->item;
        if (isset($this->is_mastercard)) $o['is_mastercard'] = $this->is_mastercard;
        if (isset($this->is_visa)) $o['is_visa'] = $this->is_visa;
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        return empty($o) ? new class(){} : $o;
    }
}

PHP FinancePaymentV4CreateIdRequest DTOs

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

HTTP + CSV

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

POST /Finance/PaymentV4/CreateId HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"department":"String","item":"String","is_mastercard":false,"is_visa":false,"regent_id":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"payment_id":"String"}