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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMPaymentDatamartResponse:
    guid: Optional[str] = None
    regent_id: int = 0
    addressee: Optional[str] = None
    soft_credit_regent_id: Optional[int] = None
    second_soft_credit_regent_id: Optional[int] = None
    donation_id: Optional[str] = None
    designation: Optional[str] = None
    pretty_designation: Optional[str] = None
    pledged: Decimal = decimal.Decimal(0)
    paid: Decimal = decimal.Decimal(0)
    paid_canadian: Decimal = decimal.Decimal(0)
    payment_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMPaymentsDatamartResponse:
    personal_payments: Optional[List[CRMPaymentDatamartResponse]] = None
    other_payments: Optional[List[CRMPaymentDatamartResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMPaymentsDatamartRequest:
    regent_id: int = 0

Python 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>