regis

<back to all web services

CRMContactCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Contact/Create

export class CRMContactCreateRequest
{
    public regent_id?: number;
    public first_name: string;
    public last_name: string;
    public middle_name: string;
    public preferred_name: string;
    public prefix: string;
    public addressee: string;
    public primary_salutation: string;
    public former_name: string;
    public spouse_name: string;
    public spouse_is_main_contact: boolean;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public dob?: string;
    public deceased_date?: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public denomination: string;
    public connection_to_regent: string;
    public student_segment: string;
    public reason_added: string;
    public gender: string;
    public marital_status: string;
    public financial_aid_received: boolean;
    public is_applicant: boolean;
    public solicitation_method: string;
    public solicitation_exceptions: string;
    public campaign_monitor_optin: boolean;
    public campaign_monitor_suppressed: boolean;
    public campaign_monitor_lists: string;
    public email: string;
    public email_secondary: string;
    public phone_home: string;
    public phone_bus: string;
    public phone_cell: string;
    public no_mail: boolean;
    public no_email: boolean;
    public no_bulk_email: boolean;
    public no_phone: boolean;
    public no_marketing_materials: boolean;
    public prefers_email: boolean;
    public prefers_phone: boolean;
    public last_credit_class?: string;
    public last_audit_class?: string;
    public last_oncampus_class?: string;
    public last_distance_education_class?: string;
    public last_evening_weekend_class?: string;
    public last_summer_class?: string;
    public last_marketplace_class?: string;
    public last_anglican_studies_class?: string;
    public image_base64: string;
    public owning_username: string;

    public constructor(init?: Partial<CRMContactCreateRequest>) { (Object as any).assign(this, init); }
}

TypeScript CRMContactCreateRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /DynamicsCRM/Contact/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMContactCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <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>
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>