regis

<back to all web services

CRMDonationUpsertRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Donation/Upsert
CRMDonationUpsertRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idbodyintNo
soft_credit_regent_idbodyint?No
soft_credit_second_regent_idbodyint?No
import_idbodyint?No
is_contactbodyboolNo
is_accountbodyboolNo
namebodystringNo
descriptionbodystringNo
total_pledge_amountbodydecimalNo
receipt_amountbodydecimalNo
currencybodystringNo
receipting_organizationbodystringNo
typebodystringNo
gift_datebodyDateTime?No
cheque_numberbodystringNo
do_not_receiptbodyboolNo
is_completebodyboolNo
anonymousbodyboolNo
gift_batchbodystringNo
sourcebodystringNo
channelbodystringNo
designationbodystringNo
designation_descriptionbodystringNo
campaignbodystringNo
campaign_codebodystringNo
campaign_descriptionbodystringNo
campaign_start_datebodyDateTime?No
campaign_end_datebodyDateTime?No
campaign_goalbodydecimal?No
appealbodystringNo
appeal_codebodystringNo
appeal_descriptionbodystringNo
appeal_start_datebodyDateTime?No
appeal_end_datebodyDateTime?No
appeal_goalbodydecimal?No
added_datebodyDateTime?No

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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-01,
	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-01,
	campaign_end_date: 0001-01-01,
	campaign_goal: 0,
	appeal: String,
	appeal_code: String,
	appeal_description: String,
	appeal_start_date: 0001-01-01,
	appeal_end_date: 0001-01-01,
	appeal_goal: 0,
	added_date: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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