regis

<back to all web services

CRMPaymentsDatamartRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/PaymentsDatamart
POST/DynamicsCRM/PaymentsDatamart/{regent_id}
<?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 CRMPaymentDatamartResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $guid=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $addressee=null,
        /** @var int|null */
        public ?int $soft_credit_regent_id=null,
        /** @var int|null */
        public ?int $second_soft_credit_regent_id=null,
        /** @var string|null */
        public ?string $donation_id=null,
        /** @var string|null */
        public ?string $designation=null,
        /** @var string|null */
        public ?string $pretty_designation=null,
        /** @var float */
        public float $pledged=0.0,
        /** @var float */
        public float $paid=0.0,
        /** @var float */
        public float $paid_canadian=0.0,
        /** @var DateTime */
        public DateTime $payment_date=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['guid'])) $this->guid = $o['guid'];
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['addressee'])) $this->addressee = $o['addressee'];
        if (isset($o['soft_credit_regent_id'])) $this->soft_credit_regent_id = $o['soft_credit_regent_id'];
        if (isset($o['second_soft_credit_regent_id'])) $this->second_soft_credit_regent_id = $o['second_soft_credit_regent_id'];
        if (isset($o['donation_id'])) $this->donation_id = $o['donation_id'];
        if (isset($o['designation'])) $this->designation = $o['designation'];
        if (isset($o['pretty_designation'])) $this->pretty_designation = $o['pretty_designation'];
        if (isset($o['pledged'])) $this->pledged = $o['pledged'];
        if (isset($o['paid'])) $this->paid = $o['paid'];
        if (isset($o['paid_canadian'])) $this->paid_canadian = $o['paid_canadian'];
        if (isset($o['payment_date'])) $this->payment_date = JsonConverters::from('DateTime', $o['payment_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->guid)) $o['guid'] = $this->guid;
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->addressee)) $o['addressee'] = $this->addressee;
        if (isset($this->soft_credit_regent_id)) $o['soft_credit_regent_id'] = $this->soft_credit_regent_id;
        if (isset($this->second_soft_credit_regent_id)) $o['second_soft_credit_regent_id'] = $this->second_soft_credit_regent_id;
        if (isset($this->donation_id)) $o['donation_id'] = $this->donation_id;
        if (isset($this->designation)) $o['designation'] = $this->designation;
        if (isset($this->pretty_designation)) $o['pretty_designation'] = $this->pretty_designation;
        if (isset($this->pledged)) $o['pledged'] = $this->pledged;
        if (isset($this->paid)) $o['paid'] = $this->paid;
        if (isset($this->paid_canadian)) $o['paid_canadian'] = $this->paid_canadian;
        if (isset($this->payment_date)) $o['payment_date'] = JsonConverters::to('DateTime', $this->payment_date);
        return empty($o) ? new class(){} : $o;
    }
}

class CRMPaymentsDatamartResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<CRMPaymentDatamartResponse>|null */
        public ?array $personal_payments=null,
        /** @var array<CRMPaymentDatamartResponse>|null */
        public ?array $other_payments=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['personal_payments'])) $this->personal_payments = JsonConverters::fromArray('CRMPaymentDatamartResponse', $o['personal_payments']);
        if (isset($o['other_payments'])) $this->other_payments = JsonConverters::fromArray('CRMPaymentDatamartResponse', $o['other_payments']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->personal_payments)) $o['personal_payments'] = JsonConverters::toArray('CRMPaymentDatamartResponse', $this->personal_payments);
        if (isset($this->other_payments)) $o['other_payments'] = JsonConverters::toArray('CRMPaymentDatamartResponse', $this->other_payments);
        return empty($o) ? new class(){} : $o;
    }
}

class CRMPaymentsDatamartRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $regent_id=0
    ) {
    }

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

PHP CRMPaymentsDatamartRequest 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 /DynamicsCRM/PaymentsDatamart HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMPaymentsDatamartRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <regent_id>0</regent_id>
</CRMPaymentsDatamartRequest>

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

<CRMPaymentsDatamartResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Responses">
  <other_payments>
    <CRMPaymentDatamartResponse>
      <addressee>String</addressee>
      <designation>String</designation>
      <donation_id>String</donation_id>
      <guid>String</guid>
      <paid>0</paid>
      <paid_canadian>0</paid_canadian>
      <payment_date>0001-01-01T00:00:00</payment_date>
      <pledged>0</pledged>
      <pretty_designation>String</pretty_designation>
      <regent_id>0</regent_id>
      <second_soft_credit_regent_id>0</second_soft_credit_regent_id>
      <soft_credit_regent_id>0</soft_credit_regent_id>
    </CRMPaymentDatamartResponse>
  </other_payments>
  <personal_payments>
    <CRMPaymentDatamartResponse>
      <addressee>String</addressee>
      <designation>String</designation>
      <donation_id>String</donation_id>
      <guid>String</guid>
      <paid>0</paid>
      <paid_canadian>0</paid_canadian>
      <payment_date>0001-01-01T00:00:00</payment_date>
      <pledged>0</pledged>
      <pretty_designation>String</pretty_designation>
      <regent_id>0</regent_id>
      <second_soft_credit_regent_id>0</second_soft_credit_regent_id>
      <soft_credit_regent_id>0</soft_credit_regent_id>
    </CRMPaymentDatamartResponse>
  </personal_payments>
</CRMPaymentsDatamartResponse>