regis

<back to all web services

CRMContactsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Contacts
CRMContactsRequest Parameters:
NameParameterData TypeRequiredDescription
create_in_regisbodyboolNo

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/Contacts HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	create_in_regis: False
}
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
	}
]