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

{"regent_id":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"personal_payments":[{"guid":"String","regent_id":0,"addressee":"String","soft_credit_regent_id":0,"second_soft_credit_regent_id":0,"donation_id":"String","designation":"String","pretty_designation":"String","pledged":0,"paid":0,"paid_canadian":0,"payment_date":"0001-01-01T00:00:00.0000000"}],"other_payments":[{"guid":"String","regent_id":0,"addressee":"String","soft_credit_regent_id":0,"second_soft_credit_regent_id":0,"donation_id":"String","designation":"String","pretty_designation":"String","pledged":0,"paid":0,"paid_canadian":0,"payment_date":"0001-01-01T00:00:00.0000000"}]}