regis

<back to all web services

CRMContactCreateMultipleRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Contact/Create/Multiple
"use strict";
export class CRMContactCreateRequest {
    /** @param {{regent_id?:number,first_name?:string,last_name?:string,middle_name?:string,preferred_name?:string,prefix?:string,addressee?:string,primary_salutation?:string,former_name?:string,spouse_name?:string,spouse_is_main_contact?:boolean,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,dob?:string,deceased_date?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,denomination?:string,connection_to_regent?:string,student_segment?:string,reason_added?:string,gender?:string,marital_status?:string,financial_aid_received?:boolean,is_applicant?:boolean,solicitation_method?:string,solicitation_exceptions?:string,campaign_monitor_optin?:boolean,campaign_monitor_suppressed?:boolean,campaign_monitor_lists?:string,email?:string,email_secondary?:string,phone_home?:string,phone_bus?:string,phone_cell?:string,no_mail?:boolean,no_email?:boolean,no_bulk_email?:boolean,no_phone?:boolean,no_marketing_materials?:boolean,prefers_email?:boolean,prefers_phone?:boolean,last_credit_class?:string,last_audit_class?:string,last_oncampus_class?:string,last_distance_education_class?:string,last_evening_weekend_class?:string,last_summer_class?:string,last_marketplace_class?:string,last_anglican_studies_class?:string,image_base64?:string,owning_username?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    prefix;
    /** @type {string} */
    addressee;
    /** @type {string} */
    primary_salutation;
    /** @type {string} */
    former_name;
    /** @type {string} */
    spouse_name;
    /** @type {boolean} */
    spouse_is_main_contact;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {?string} */
    dob;
    /** @type {?string} */
    deceased_date;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    denomination;
    /** @type {string} */
    connection_to_regent;
    /** @type {string} */
    student_segment;
    /** @type {string} */
    reason_added;
    /** @type {string} */
    gender;
    /** @type {string} */
    marital_status;
    /** @type {boolean} */
    financial_aid_received;
    /** @type {boolean} */
    is_applicant;
    /** @type {string} */
    solicitation_method;
    /** @type {string} */
    solicitation_exceptions;
    /** @type {boolean} */
    campaign_monitor_optin;
    /** @type {boolean} */
    campaign_monitor_suppressed;
    /** @type {string} */
    campaign_monitor_lists;
    /** @type {string} */
    email;
    /** @type {string} */
    email_secondary;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    phone_cell;
    /** @type {boolean} */
    no_mail;
    /** @type {boolean} */
    no_email;
    /** @type {boolean} */
    no_bulk_email;
    /** @type {boolean} */
    no_phone;
    /** @type {boolean} */
    no_marketing_materials;
    /** @type {boolean} */
    prefers_email;
    /** @type {boolean} */
    prefers_phone;
    /** @type {?string} */
    last_credit_class;
    /** @type {?string} */
    last_audit_class;
    /** @type {?string} */
    last_oncampus_class;
    /** @type {?string} */
    last_distance_education_class;
    /** @type {?string} */
    last_evening_weekend_class;
    /** @type {?string} */
    last_summer_class;
    /** @type {?string} */
    last_marketplace_class;
    /** @type {?string} */
    last_anglican_studies_class;
    /** @type {string} */
    image_base64;
    /** @type {string} */
    owning_username;
}
export class CRMContactCreateMultipleRequest {
    /** @param {{contacts?:CRMContactCreateRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CRMContactCreateRequest[]} */
    contacts;
}

JavaScript CRMContactCreateMultipleRequest 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/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>