Required role: | REGISUserRole |
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<CRMDonationUpsertRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
<added_date>0001-01-01T00:00:00</added_date>
<anonymous>false</anonymous>
<appeal>String</appeal>
<appeal_code>String</appeal_code>
<appeal_description>String</appeal_description>
<appeal_end_date>0001-01-01T00:00:00</appeal_end_date>
<appeal_goal>0</appeal_goal>
<appeal_start_date>0001-01-01T00:00:00</appeal_start_date>
<campaign>String</campaign>
<campaign_code>String</campaign_code>
<campaign_description>String</campaign_description>
<campaign_end_date>0001-01-01T00:00:00</campaign_end_date>
<campaign_goal>0</campaign_goal>
<campaign_start_date>0001-01-01T00:00:00</campaign_start_date>
<channel>String</channel>
<cheque_number>String</cheque_number>
<currency>String</currency>
<description>String</description>
<designation>String</designation>
<designation_description>String</designation_description>
<do_not_receipt>false</do_not_receipt>
<gift_batch>String</gift_batch>
<gift_date>0001-01-01T00:00:00</gift_date>
<import_id>0</import_id>
<is_account>false</is_account>
<is_complete>false</is_complete>
<is_contact>false</is_contact>
<name>String</name>
<receipt_amount>0</receipt_amount>
<receipting_organization>String</receipting_organization>
<regent_id>0</regent_id>
<soft_credit_regent_id>0</soft_credit_regent_id>
<soft_credit_second_regent_id>0</soft_credit_second_regent_id>
<source>String</source>
<total_pledge_amount>0</total_pledge_amount>
<type>String</type>
</CRMDonationUpsertRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>String</d4p1:Key> <d4p1:Value>String</d4p1:Value> </d4p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> </ResponseStatus>