| Required role: | REGISUserRole |
| POST | /DynamicsCRM/DonationsLegacy |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| donations | form | List<CRMDonationResponse> | No | |
| from_date | form | DateTime? | No | |
| to_date | form | DateTime? | No | |
| start_version_number | form | int? | No | |
| end_version_number | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| regent_id | form | int | No | |
| contact_addressee | form | string | No | |
| donor_first_name | form | string | No | |
| donor_last_name | form | string | No | |
| donor_addressee | form | string | No | |
| donor_city | form | string | No | |
| donor_country | form | string | No | |
| donor_owner_full_name | form | string | No | |
| is_contact | form | bool | No | |
| is_account | form | bool | No | |
| soft_credit_regent_id | form | int? | No | |
| soft_credit_contact_addressee | form | string | No | |
| soft_credit_contact_first_name | form | string | No | |
| soft_credit_contact_last_name | form | string | No | |
| soft_credit_contact_spouse_is_main_contact | form | bool | No | |
| soft_credit_contact_city | form | string | No | |
| soft_credit_contact_country | form | string | No | |
| soft_credit_contact_owner_full_name | form | string | No | |
| soft_credit_second_regent_id | form | string | No | |
| soft_credit_second_contact_addressee | form | string | No | |
| soft_credit_second_contact_first_name | form | string | No | |
| soft_credit_second_contact_last_name | form | string | No | |
| soft_credit_second_contact_spouse_is_main_contact | form | bool | No | |
| soft_credit_second_contact_city | form | string | No | |
| soft_credit_second_contact_country | form | string | No | |
| soft_credit_second_contact_owner_full_name | form | string | No | |
| spouse_is_main_contact | form | bool | No | |
| import_id | form | int? | No | |
| donation_id | form | string | No | |
| guid | form | string | No | |
| name | form | string | No | |
| description | form | string | No | |
| appeal_code | form | string | No | |
| designation | form | string | No | |
| designation_description | form | string | No | |
| general_ledger_account_number | form | string | No | |
| campaign | form | string | No | |
| total_pledge_amount | form | decimal | No | |
| total_paid_amount | form | decimal | No | |
| receipt_amount | form | decimal | No | |
| exchange_rate | form | decimal? | No | |
| total_paid_canadian_amount | form | decimal? | No | |
| is_recurring | form | bool | No | |
| is_parent_donation | form | bool | No | |
| currency | form | string | No | |
| source | form | string | No | |
| channel | form | string | No | |
| receipting_organization | form | string | No | |
| type | form | string | No | |
| acknowledgment_sent | form | bool | No | |
| send_acknowledgment | form | bool | No | |
| acknowledgment_template_guid | form | string | No | |
| parent_guid | form | string | No | |
| anonymous | form | bool | No | |
| gift_date | form | DateTime? | No | |
| recurring_gift_start_date | form | DateTime? | No | |
| recurring_gift_end_date | form | DateTime? | No | |
| cheque_number | form | string | No | |
| version_number | form | int | No | |
| added_date | form | DateTime? | No |
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/DonationsLegacy HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
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
}