regis

<back to all web services

CRMDonationUpsertRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Donation/Upsert
"use strict";
export class CRMDonationUpsertRequest {
    /** @param {{regent_id?:number,soft_credit_regent_id?:number,soft_credit_second_regent_id?:number,import_id?:number,is_contact?:boolean,is_account?:boolean,name?:string,description?:string,total_pledge_amount?:number,receipt_amount?:number,currency?:string,receipting_organization?:string,type?:string,gift_date?:string,cheque_number?:string,do_not_receipt?:boolean,is_complete?:boolean,anonymous?:boolean,gift_batch?:string,source?:string,channel?:string,designation?:string,designation_description?:string,campaign?:string,campaign_code?:string,campaign_description?:string,campaign_start_date?:string,campaign_end_date?:string,campaign_goal?:number,appeal?:string,appeal_code?:string,appeal_description?:string,appeal_start_date?:string,appeal_end_date?:string,appeal_goal?:number,added_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {?number} */
    soft_credit_regent_id;
    /** @type {?number} */
    soft_credit_second_regent_id;
    /** @type {?number} */
    import_id;
    /** @type {boolean} */
    is_contact;
    /** @type {boolean} */
    is_account;
    /** @type {string} */
    name;
    /** @type {string} */
    description;
    /** @type {number} */
    total_pledge_amount;
    /** @type {number} */
    receipt_amount;
    /** @type {string} */
    currency;
    /** @type {string} */
    receipting_organization;
    /** @type {string} */
    type;
    /** @type {?string} */
    gift_date;
    /** @type {string} */
    cheque_number;
    /** @type {boolean} */
    do_not_receipt;
    /** @type {boolean} */
    is_complete;
    /** @type {boolean} */
    anonymous;
    /** @type {string} */
    gift_batch;
    /** @type {string} */
    source;
    /** @type {string} */
    channel;
    /** @type {string} */
    designation;
    /** @type {string} */
    designation_description;
    /** @type {string} */
    campaign;
    /** @type {string} */
    campaign_code;
    /** @type {string} */
    campaign_description;
    /** @type {?string} */
    campaign_start_date;
    /** @type {?string} */
    campaign_end_date;
    /** @type {?number} */
    campaign_goal;
    /** @type {string} */
    appeal;
    /** @type {string} */
    appeal_code;
    /** @type {string} */
    appeal_description;
    /** @type {?string} */
    appeal_start_date;
    /** @type {?string} */
    appeal_end_date;
    /** @type {?number} */
    appeal_goal;
    /** @type {?string} */
    added_date;
}

JavaScript CRMDonationUpsertRequest 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/Donation/Upsert HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMDonationUpsertRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <added_date>0001-01-01T00:00:00</added_date>
  <anonymous>false</anonymous>
  <appeal>String</appeal>
  <appeal_code>String</appeal_code>
  <appeal_description>String</appeal_description>
  <appeal_end_date>0001-01-01T00:00:00</appeal_end_date>
  <appeal_goal>0</appeal_goal>
  <appeal_start_date>0001-01-01T00:00:00</appeal_start_date>
  <campaign>String</campaign>
  <campaign_code>String</campaign_code>
  <campaign_description>String</campaign_description>
  <campaign_end_date>0001-01-01T00:00:00</campaign_end_date>
  <campaign_goal>0</campaign_goal>
  <campaign_start_date>0001-01-01T00:00:00</campaign_start_date>
  <channel>String</channel>
  <cheque_number>String</cheque_number>
  <currency>String</currency>
  <description>String</description>
  <designation>String</designation>
  <designation_description>String</designation_description>
  <do_not_receipt>false</do_not_receipt>
  <gift_batch>String</gift_batch>
  <gift_date>0001-01-01T00:00:00</gift_date>
  <import_id>0</import_id>
  <is_account>false</is_account>
  <is_complete>false</is_complete>
  <is_contact>false</is_contact>
  <name>String</name>
  <receipt_amount>0</receipt_amount>
  <receipting_organization>String</receipting_organization>
  <regent_id>0</regent_id>
  <soft_credit_regent_id>0</soft_credit_regent_id>
  <soft_credit_second_regent_id>0</soft_credit_second_regent_id>
  <source>String</source>
  <total_pledge_amount>0</total_pledge_amount>
  <type>String</type>
</CRMDonationUpsertRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>