Required role: | REGISUserRole |
POST | /DynamicsCRM/Contact/Create/Multiple |
---|
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 CRMContactCreateRequest:
regent_id: Optional[int] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
middle_name: Optional[str] = None
preferred_name: Optional[str] = None
prefix: Optional[str] = None
addressee: Optional[str] = None
primary_salutation: Optional[str] = None
former_name: Optional[str] = None
spouse_name: Optional[str] = None
spouse_is_main_contact: bool = False
addr1: Optional[str] = None
addr2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
country: Optional[str] = None
code: Optional[str] = None
dob: Optional[datetime.datetime] = None
deceased_date: Optional[datetime.datetime] = None
citizenship: Optional[str] = None
citizenship_other: Optional[str] = None
permanent_resident: Optional[str] = None
denomination: Optional[str] = None
connection_to_regent: Optional[str] = None
student_segment: Optional[str] = None
reason_added: Optional[str] = None
gender: Optional[str] = None
marital_status: Optional[str] = None
financial_aid_received: bool = False
is_applicant: bool = False
solicitation_method: Optional[str] = None
solicitation_exceptions: Optional[str] = None
campaign_monitor_optin: bool = False
campaign_monitor_suppressed: bool = False
campaign_monitor_lists: Optional[str] = None
email: Optional[str] = None
email_secondary: Optional[str] = None
phone_home: Optional[str] = None
phone_bus: Optional[str] = None
phone_cell: Optional[str] = None
no_mail: bool = False
no_email: bool = False
no_bulk_email: bool = False
no_phone: bool = False
no_marketing_materials: bool = False
prefers_email: bool = False
prefers_phone: bool = False
last_credit_class: Optional[datetime.datetime] = None
last_audit_class: Optional[datetime.datetime] = None
last_oncampus_class: Optional[datetime.datetime] = None
last_distance_education_class: Optional[datetime.datetime] = None
last_evening_weekend_class: Optional[datetime.datetime] = None
last_summer_class: Optional[datetime.datetime] = None
last_marketplace_class: Optional[datetime.datetime] = None
last_anglican_studies_class: Optional[datetime.datetime] = None
image_base64: Optional[str] = None
owning_username: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMContactCreateMultipleRequest:
contacts: Optional[List[CRMContactCreateRequest]] = None
Python CRMContactCreateMultipleRequest 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/Contact/Create/Multiple HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CRMContactCreateMultipleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
<contacts>
<CRMContactCreateRequest>
<addr1>String</addr1>
<addr2>String</addr2>
<addressee>String</addressee>
<campaign_monitor_lists>String</campaign_monitor_lists>
<campaign_monitor_optin>false</campaign_monitor_optin>
<campaign_monitor_suppressed>false</campaign_monitor_suppressed>
<citizenship>String</citizenship>
<citizenship_other>String</citizenship_other>
<city>String</city>
<code>String</code>
<connection_to_regent>String</connection_to_regent>
<country>String</country>
<deceased_date>0001-01-01T00:00:00</deceased_date>
<denomination>String</denomination>
<dob>0001-01-01T00:00:00</dob>
<email>String</email>
<email_secondary>String</email_secondary>
<financial_aid_received>false</financial_aid_received>
<first_name>String</first_name>
<former_name>String</former_name>
<gender>String</gender>
<image_base64>String</image_base64>
<is_applicant>false</is_applicant>
<last_anglican_studies_class>0001-01-01T00:00:00</last_anglican_studies_class>
<last_audit_class>0001-01-01T00:00:00</last_audit_class>
<last_credit_class>0001-01-01T00:00:00</last_credit_class>
<last_distance_education_class>0001-01-01T00:00:00</last_distance_education_class>
<last_evening_weekend_class>0001-01-01T00:00:00</last_evening_weekend_class>
<last_marketplace_class>0001-01-01T00:00:00</last_marketplace_class>
<last_name>String</last_name>
<last_oncampus_class>0001-01-01T00:00:00</last_oncampus_class>
<last_summer_class>0001-01-01T00:00:00</last_summer_class>
<marital_status>String</marital_status>
<middle_name>String</middle_name>
<no_bulk_email>false</no_bulk_email>
<no_email>false</no_email>
<no_mail>false</no_mail>
<no_marketing_materials>false</no_marketing_materials>
<no_phone>false</no_phone>
<owning_username>String</owning_username>
<permanent_resident>String</permanent_resident>
<phone_bus>String</phone_bus>
<phone_cell>String</phone_cell>
<phone_home>String</phone_home>
<preferred_name>String</preferred_name>
<prefers_email>false</prefers_email>
<prefers_phone>false</prefers_phone>
<prefix>String</prefix>
<primary_salutation>String</primary_salutation>
<reason_added>String</reason_added>
<regent_id>0</regent_id>
<solicitation_exceptions>String</solicitation_exceptions>
<solicitation_method>String</solicitation_method>
<spouse_is_main_contact>false</spouse_is_main_contact>
<spouse_name>String</spouse_name>
<state>String</state>
<student_segment>String</student_segment>
</CRMContactCreateRequest>
</contacts>
</CRMContactCreateMultipleRequest>
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>