regis

<back to all web services

CRMCRUXUpsertRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/CRUX/Upsert
"use strict";
export class CRMCRUXSubscriptionUpsertRequest {
    /** @param {{payment_amount?:number,import_id?:number,payment_date?:string,start_date?:string,end_date?:string,added_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    payment_amount;
    /** @type {?number} */
    import_id;
    /** @type {?string} */
    payment_date;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {?string} */
    added_date;
}
export class CRMCRUXUpsertRequest {
    /** @param {{regent_id?:number,status?:string,notes?:string,is_contact?:boolean,is_account?:boolean,subscriptions?:CRMCRUXSubscriptionUpsertRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {string} */
    status;
    /** @type {string} */
    notes;
    /** @type {boolean} */
    is_contact;
    /** @type {boolean} */
    is_account;
    /** @type {CRMCRUXSubscriptionUpsertRequest[]} */
    subscriptions;
}

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

{
	regent_id: 0,
	status: String,
	notes: String,
	is_contact: False,
	is_account: False,
	subscriptions: 
	[
		{
			payment_amount: 0,
			import_id: 0,
			payment_date: 0001-01-01,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			added_date: 0001-01-01
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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