regis

<back to all web services

CRMContactRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Contact/{regent_id}
CRMContactRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idpathintNo
CRMContactResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
guidformstringNo
regent_idformintNo
full_nameformstringNo
first_nameformstringNo
last_nameformstringNo
middle_nameformstringNo
preferred_nameformstringNo
former_nameformstringNo
prefixformstringNo
addresseeformstringNo
primary_salutationformstringNo
spouse_nameformstringNo
spouse_is_main_contactformboolNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
dobformDateTime?No
birth_monthformstringNo
deceased_dateformDateTime?No
ageformint?No
denominationformstringNo
connection_to_regentformstringNo
student_statusformstringNo
student_segmentformstringNo
engagement_scoreformint?No
reason_addedformstringNo
genderformstringNo
marital_statusformstringNo
financial_aid_receivedformboolNo
is_applicantformboolNo
solicitation_methodformstringNo
solicitation_exceptionsformstringNo
campaign_monitor_optinformboolNo
campaign_monitor_suppressedformboolNo
campaign_monitor_last_event_dateformDateTime?No
campaign_monitor_last_reframe_purchase_dtformDateTime?No
consent_to_receive_bulk_emailformstringNo
last_consent_sourceformstringNo
last_consent_dateformDateTime?No
campaign_monitor_listsformstringNo
emailformstringNo
email_secondaryformstringNo
phone_homeformstringNo
phone_busformstringNo
phone_cellformstringNo
no_mailformboolNo
no_emailformboolNo
no_bulk_emailformboolNo
no_phoneformboolNo
no_marketing_materialsformboolNo
prefers_emailformboolNo
prefers_phoneformboolNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
current_programformstringNo
total_audit_hoursformdecimal?No
total_credit_hoursformdecimal?No
last_credit_classformDateTime?No
last_audit_classformDateTime?No
last_oncampus_classformDateTime?No
last_distance_education_classformDateTime?No
last_evening_weekend_classformDateTime?No
last_summer_classformDateTime?No
last_marketplace_classformDateTime?No
last_anglican_studies_classformDateTime?No
all_terms_registeredformstringNo
all_terms_registered_onsiteformstringNo
all_terms_registered_onlineformstringNo
has_regent_degreeformboolNo
owner_full_nameformstringNo

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

HTTP + JSV

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

POST /DynamicsCRM/Contact/{regent_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	guid: String,
	regent_id: 0,
	full_name: String,
	first_name: String,
	last_name: String,
	middle_name: String,
	preferred_name: String,
	former_name: String,
	prefix: String,
	addressee: String,
	primary_salutation: String,
	spouse_name: String,
	spouse_is_main_contact: False,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	dob: 0001-01-01,
	birth_month: String,
	deceased_date: 0001-01-01,
	age: 0,
	denomination: String,
	connection_to_regent: String,
	student_status: String,
	student_segment: String,
	engagement_score: 0,
	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_last_event_date: 0001-01-01,
	campaign_monitor_last_reframe_purchase_dt: 0001-01-01,
	consent_to_receive_bulk_email: String,
	last_consent_source: String,
	last_consent_date: 0001-01-01,
	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,
	added_by: String,
	added_date: 0001-01-01,
	changed_by: String,
	changed_date: 0001-01-01,
	current_program: String,
	total_audit_hours: 0,
	total_credit_hours: 0,
	last_credit_class: 0001-01-01,
	last_audit_class: 0001-01-01,
	last_oncampus_class: 0001-01-01,
	last_distance_education_class: 0001-01-01,
	last_evening_weekend_class: 0001-01-01,
	last_summer_class: 0001-01-01,
	last_marketplace_class: 0001-01-01,
	last_anglican_studies_class: 0001-01-01,
	all_terms_registered: String,
	all_terms_registered_onsite: String,
	all_terms_registered_online: String,
	has_regent_degree: False,
	owner_full_name: String
}