regis

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