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}

export class CRMPaymentDatamartResponse
{
    public guid: string;
    public regent_id: number;
    public addressee: string;
    public soft_credit_regent_id?: number;
    public second_soft_credit_regent_id?: number;
    public donation_id: string;
    public designation: string;
    public pretty_designation: string;
    public pledged: number;
    public paid: number;
    public paid_canadian: number;
    public payment_date: string;

    public constructor(init?: Partial<CRMPaymentDatamartResponse>) { (Object as any).assign(this, init); }
}

export class CRMPaymentsDatamartResponse
{
    public personal_payments: CRMPaymentDatamartResponse[];
    public other_payments: CRMPaymentDatamartResponse[];

    public constructor(init?: Partial<CRMPaymentsDatamartResponse>) { (Object as any).assign(this, init); }
}

export class CRMPaymentsDatamartRequest
{
    public regent_id: number;

    public constructor(init?: Partial<CRMPaymentsDatamartRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"}]}