| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Donations | ||
|---|---|---|---|
| POST | /DynamicsCRM/Donations/{regent_id} |
export class CRMDonationResponse
{
public regent_id: number;
public contact_addressee: string;
public donor_first_name: string;
public donor_last_name: string;
public donor_addressee: string;
public donor_city: string;
public donor_country: string;
public donor_owner_full_name: string;
public is_contact: boolean;
public is_account: boolean;
public soft_credit_regent_id?: number;
public soft_credit_contact_addressee: string;
public soft_credit_contact_first_name: string;
public soft_credit_contact_last_name: string;
public soft_credit_contact_spouse_is_main_contact: boolean;
public soft_credit_contact_city: string;
public soft_credit_contact_country: string;
public soft_credit_contact_owner_full_name: string;
public soft_credit_second_regent_id: string;
public soft_credit_second_contact_addressee: string;
public soft_credit_second_contact_first_name: string;
public soft_credit_second_contact_last_name: string;
public soft_credit_second_contact_spouse_is_main_contact: boolean;
public soft_credit_second_contact_city: string;
public soft_credit_second_contact_country: string;
public soft_credit_second_contact_owner_full_name: string;
public spouse_is_main_contact: boolean;
public import_id?: number;
public donation_id: string;
public guid: string;
public name: string;
public description: string;
public appeal_code: string;
public designation: string;
public designation_description: string;
public general_ledger_account_number: string;
public campaign: string;
public total_pledge_amount: number;
public total_paid_amount: number;
public receipt_amount: number;
public exchange_rate?: number;
public total_paid_canadian_amount?: number;
public is_recurring: boolean;
public is_parent_donation: boolean;
public currency: string;
public source: string;
public channel: string;
public receipting_organization: string;
public type: string;
public acknowledgment_sent: boolean;
public send_acknowledgment: boolean;
public acknowledgment_template_guid: string;
public parent_guid: string;
public anonymous: boolean;
public gift_date?: string;
public recurring_gift_start_date?: string;
public recurring_gift_end_date?: string;
public cheque_number: string;
public version_number: number;
public added_date?: string;
public constructor(init?: Partial<CRMDonationResponse>) { (Object as any).assign(this, init); }
}
export class CRMDonationsResponse
{
public responseStatus: ResponseStatus;
public donations: CRMDonationResponse[];
public from_date?: string;
public to_date?: string;
public start_version_number?: number;
public end_version_number?: number;
public constructor(init?: Partial<CRMDonationsResponse>) { (Object as any).assign(this, init); }
}
export class CRMDonationsRequest
{
public regent_id?: number;
public from_date?: string;
public to_date?: string;
public start_version_number?: number;
public end_version_number?: number;
public is_missing_acknowledgement: boolean;
public has_acknowledgement_letter: boolean;
public constructor(init?: Partial<CRMDonationsRequest>) { (Object as any).assign(this, init); }
}
TypeScript CRMDonationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /DynamicsCRM/Donations HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
regent_id: 0,
from_date: 0001-01-01,
to_date: 0001-01-01,
start_version_number: 0,
end_version_number: 0,
is_missing_acknowledgement: False,
has_acknowledgement_letter: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
donations:
[
{
regent_id: 0,
contact_addressee: String,
donor_first_name: String,
donor_last_name: String,
donor_addressee: String,
donor_city: String,
donor_country: String,
donor_owner_full_name: String,
is_contact: False,
is_account: False,
soft_credit_regent_id: 0,
soft_credit_contact_addressee: String,
soft_credit_contact_first_name: String,
soft_credit_contact_last_name: String,
soft_credit_contact_spouse_is_main_contact: False,
soft_credit_contact_city: String,
soft_credit_contact_country: String,
soft_credit_contact_owner_full_name: String,
soft_credit_second_regent_id: String,
soft_credit_second_contact_addressee: String,
soft_credit_second_contact_first_name: String,
soft_credit_second_contact_last_name: String,
soft_credit_second_contact_spouse_is_main_contact: False,
soft_credit_second_contact_city: String,
soft_credit_second_contact_country: String,
soft_credit_second_contact_owner_full_name: String,
spouse_is_main_contact: False,
import_id: 0,
donation_id: String,
guid: String,
name: String,
description: String,
appeal_code: String,
designation: String,
designation_description: String,
general_ledger_account_number: String,
campaign: String,
total_pledge_amount: 0,
total_paid_amount: 0,
receipt_amount: 0,
exchange_rate: 0,
total_paid_canadian_amount: 0,
is_recurring: False,
is_parent_donation: False,
currency: String,
source: String,
channel: String,
receipting_organization: String,
type: String,
acknowledgment_sent: False,
send_acknowledgment: False,
acknowledgment_template_guid: String,
parent_guid: String,
anonymous: False,
gift_date: 0001-01-01,
recurring_gift_start_date: 0001-01-01,
recurring_gift_end_date: 0001-01-01,
cheque_number: String,
version_number: 0,
added_date: 0001-01-01
}
],
from_date: 0001-01-01,
to_date: 0001-01-01,
start_version_number: 0,
end_version_number: 0
}