regis

<back to all web services

CRMDonationUpsertRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Donation/Upsert
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMDonationUpsertRequest:
    regent_id: int = 0
    soft_credit_regent_id: Optional[int] = None
    soft_credit_second_regent_id: Optional[int] = None
    import_id: Optional[int] = None
    is_contact: bool = False
    is_account: bool = False
    name: Optional[str] = None
    description: Optional[str] = None
    total_pledge_amount: Decimal = decimal.Decimal(0)
    receipt_amount: Decimal = decimal.Decimal(0)
    currency: Optional[str] = None
    receipting_organization: Optional[str] = None
    type: Optional[str] = None
    gift_date: Optional[datetime.datetime] = None
    cheque_number: Optional[str] = None
    do_not_receipt: bool = False
    is_complete: bool = False
    anonymous: bool = False
    gift_batch: Optional[str] = None
    source: Optional[str] = None
    channel: Optional[str] = None
    designation: Optional[str] = None
    designation_description: Optional[str] = None
    campaign: Optional[str] = None
    campaign_code: Optional[str] = None
    campaign_description: Optional[str] = None
    campaign_start_date: Optional[datetime.datetime] = None
    campaign_end_date: Optional[datetime.datetime] = None
    campaign_goal: Optional[Decimal] = None
    appeal: Optional[str] = None
    appeal_code: Optional[str] = None
    appeal_description: Optional[str] = None
    appeal_start_date: Optional[datetime.datetime] = None
    appeal_end_date: Optional[datetime.datetime] = None
    appeal_goal: Optional[Decimal] = None
    added_date: Optional[datetime.datetime] = None

Python CRMDonationUpsertRequest DTOs

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
	}
}