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}
"use strict";
export class CRMPaymentDatamartResponse {
    /** @param {{guid?:string,regent_id?:number,addressee?:string,soft_credit_regent_id?:number,second_soft_credit_regent_id?:number,donation_id?:string,designation?:string,pretty_designation?:string,pledged?:number,paid?:number,paid_canadian?:number,payment_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    addressee;
    /** @type {?number} */
    soft_credit_regent_id;
    /** @type {?number} */
    second_soft_credit_regent_id;
    /** @type {string} */
    donation_id;
    /** @type {string} */
    designation;
    /** @type {string} */
    pretty_designation;
    /** @type {number} */
    pledged;
    /** @type {number} */
    paid;
    /** @type {number} */
    paid_canadian;
    /** @type {string} */
    payment_date;
}
export class CRMPaymentsDatamartResponse {
    /** @param {{personal_payments?:CRMPaymentDatamartResponse[],other_payments?:CRMPaymentDatamartResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CRMPaymentDatamartResponse[]} */
    personal_payments;
    /** @type {CRMPaymentDatamartResponse[]} */
    other_payments;
}
export class CRMPaymentsDatamartRequest {
    /** @param {{regent_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
}

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