regis

<back to all web services

CRMAccountRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Account/{regent_id}
CRMAccountRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idpathintNo
CRMAccountResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
guidformstringNo
regent_idformintNo
nameformstringNo
other_nameformstringNo
institution_namesformstringNo
business_typeformstringNo
regent_friendly_churchformstringNo
denominationformstringNo
reason_addedformstringNo
connection_to_regentformstringNo
educational_affiliationformstringNo
accreditation_statusformstringNo
accreditation_status_notesformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
emailformstringNo
solicitation_methodformstringNo
solicitation_exceptionsformstringNo
campaign_monitor_optinformboolNo
campaign_monitor_suppressedformboolNo
consent_to_receive_bulk_emailformstringNo
last_consent_sourceformstringNo
last_consent_dateformDateTime?No
campaign_monitor_listsformstringNo
phone_homeformstringNo
phone_busformstringNo
phone_cellformstringNo
no_mailformboolNo
no_emailformboolNo
no_bulk_emailformboolNo
no_phoneformboolNo
no_marketing_materialsformboolNo
prefers_emailformboolNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
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/Account/{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,
	name: String,
	other_name: String,
	institution_names: String,
	business_type: String,
	regent_friendly_church: String,
	denomination: String,
	reason_added: String,
	connection_to_regent: String,
	educational_affiliation: String,
	accreditation_status: String,
	accreditation_status_notes: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	email: String,
	solicitation_method: String,
	solicitation_exceptions: String,
	campaign_monitor_optin: False,
	campaign_monitor_suppressed: False,
	consent_to_receive_bulk_email: String,
	last_consent_source: String,
	last_consent_date: 0001-01-01,
	campaign_monitor_lists: 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,
	added_by: String,
	added_date: 0001-01-01,
	changed_by: String,
	changed_date: 0001-01-01,
	owner_full_name: String
}