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

{"regent_id":0,"soft_credit_regent_id":0,"soft_credit_second_regent_id":0,"import_id":0,"is_contact":false,"is_account":false,"name":"String","description":"String","total_pledge_amount":0,"receipt_amount":0,"currency":"String","receipting_organization":"String","type":"String","gift_date":"0001-01-01T00:00:00.0000000","cheque_number":"String","do_not_receipt":false,"is_complete":false,"anonymous":false,"gift_batch":"String","source":"String","channel":"String","designation":"String","designation_description":"String","campaign":"String","campaign_code":"String","campaign_description":"String","campaign_start_date":"0001-01-01T00:00:00.0000000","campaign_end_date":"0001-01-01T00:00:00.0000000","campaign_goal":0,"appeal":"String","appeal_code":"String","appeal_description":"String","appeal_start_date":"0001-01-01T00:00:00.0000000","appeal_end_date":"0001-01-01T00:00:00.0000000","appeal_goal":0,"added_date":"0001-01-01T00:00:00.0000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}