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