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}
"use strict";
export class CRMAccountResponse {
    /** @param {{responseStatus?:ResponseStatus,guid?:string,regent_id?:number,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?:boolean,campaign_monitor_suppressed?:boolean,consent_to_receive_bulk_email?:string,last_consent_source?:string,last_consent_date?:string,campaign_monitor_lists?: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,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,owner_full_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    guid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    name;
    /** @type {string} */
    other_name;
    /** @type {string} */
    institution_names;
    /** @type {string} */
    business_type;
    /** @type {string} */
    regent_friendly_church;
    /** @type {string} */
    denomination;
    /** @type {string} */
    reason_added;
    /** @type {string} */
    connection_to_regent;
    /** @type {string} */
    educational_affiliation;
    /** @type {string} */
    accreditation_status;
    /** @type {string} */
    accreditation_status_notes;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    email;
    /** @type {string} */
    solicitation_method;
    /** @type {string} */
    solicitation_exceptions;
    /** @type {boolean} */
    campaign_monitor_optin;
    /** @type {boolean} */
    campaign_monitor_suppressed;
    /** @type {string} */
    consent_to_receive_bulk_email;
    /** @type {string} */
    last_consent_source;
    /** @type {?string} */
    last_consent_date;
    /** @type {string} */
    campaign_monitor_lists;
    /** @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 {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
    /** @type {string} */
    owner_full_name;
}
export class CRMAccountRequest {
    /** @param {{regent_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
}

JavaScript CRMAccountRequest DTOs

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
}