regis

<back to all web services

CRMDonationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Donations
POST/DynamicsCRM/Donations/{regent_id}
CRMDonationsRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idpathint?No
from_datebodyDateTime?No
to_datebodyDateTime?No
start_version_numberbodyint?No
end_version_numberbodyint?No
is_missing_acknowledgementbodyboolNo
has_acknowledgement_letterbodyboolNo
CRMDonationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
donationsformList<CRMDonationResponse>No
from_dateformDateTime?No
to_dateformDateTime?No
start_version_numberformint?No
end_version_numberformint?No
CRMDonationResponse Parameters:
NameParameterData TypeRequiredDescription
regent_idformintNo
contact_addresseeformstringNo
donor_first_nameformstringNo
donor_last_nameformstringNo
donor_addresseeformstringNo
donor_cityformstringNo
donor_countryformstringNo
donor_owner_full_nameformstringNo
is_contactformboolNo
is_accountformboolNo
soft_credit_regent_idformint?No
soft_credit_contact_addresseeformstringNo
soft_credit_contact_first_nameformstringNo
soft_credit_contact_last_nameformstringNo
soft_credit_contact_spouse_is_main_contactformboolNo
soft_credit_contact_cityformstringNo
soft_credit_contact_countryformstringNo
soft_credit_contact_owner_full_nameformstringNo
soft_credit_second_regent_idformstringNo
soft_credit_second_contact_addresseeformstringNo
soft_credit_second_contact_first_nameformstringNo
soft_credit_second_contact_last_nameformstringNo
soft_credit_second_contact_spouse_is_main_contactformboolNo
soft_credit_second_contact_cityformstringNo
soft_credit_second_contact_countryformstringNo
soft_credit_second_contact_owner_full_nameformstringNo
spouse_is_main_contactformboolNo
import_idformint?No
donation_idformstringNo
guidformstringNo
nameformstringNo
descriptionformstringNo
appeal_codeformstringNo
designationformstringNo
designation_descriptionformstringNo
general_ledger_account_numberformstringNo
campaignformstringNo
total_pledge_amountformdecimalNo
total_paid_amountformdecimalNo
receipt_amountformdecimalNo
exchange_rateformdecimal?No
total_paid_canadian_amountformdecimal?No
is_recurringformboolNo
is_parent_donationformboolNo
currencyformstringNo
sourceformstringNo
channelformstringNo
receipting_organizationformstringNo
typeformstringNo
acknowledgment_sentformboolNo
send_acknowledgmentformboolNo
acknowledgment_template_guidformstringNo
parent_guidformstringNo
anonymousformboolNo
gift_dateformDateTime?No
recurring_gift_start_dateformDateTime?No
recurring_gift_end_dateformDateTime?No
cheque_numberformstringNo
version_numberformintNo
added_dateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"regent_id":0,"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","start_version_number":0,"end_version_number":0,"is_missing_acknowledgement":false,"has_acknowledgement_letter":false}

HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","recurring_gift_start_date":"0001-01-01T00:00:00.0000000","recurring_gift_end_date":"0001-01-01T00:00:00.0000000","cheque_number":"String","version_number":0,"added_date":"0001-01-01T00:00:00.0000000"}],"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","start_version_number":0,"end_version_number":0}