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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"contacts":[{"regent_id":0,"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":false,"addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","dob":"0001-01-01T00:00:00.0000000","deceased_date":"0001-01-01T00:00:00.0000000","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":false,"is_applicant":false,"solicitation_method":"String","solicitation_exceptions":"String","campaign_monitor_optin":false,"campaign_monitor_suppressed":false,"campaign_monitor_lists":"String","email":"String","email_secondary":"String","phone_home":"String","phone_bus":"String","phone_cell":"String","no_mail":false,"no_email":false,"no_bulk_email":false,"no_phone":false,"no_marketing_materials":false,"prefers_email":false,"prefers_phone":false,"last_credit_class":"0001-01-01T00:00:00.0000000","last_audit_class":"0001-01-01T00:00:00.0000000","last_oncampus_class":"0001-01-01T00:00:00.0000000","last_distance_education_class":"0001-01-01T00:00:00.0000000","last_evening_weekend_class":"0001-01-01T00:00:00.0000000","last_summer_class":"0001-01-01T00:00:00.0000000","last_marketplace_class":"0001-01-01T00:00:00.0000000","last_anglican_studies_class":"0001-01-01T00:00:00.0000000","image_base64":"String","owning_username":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}