regis

SyncAddressRequest

**Requires Authentication**
Required permission:	SyncBioAndAddresses

The following routes are available for this service:
POST	/Sync/Address

"use strict";
export class SyncBioAndAddressResponse {
    /** @param {{responseStatus?:ResponseStatus,successfull?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    successfull;
}
export class SyncAddressRequest {
    /** @param {{regent_id?:number,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,email?:string,phone_home?:string,phone_bus?:string,phone_cell?:string,queued_by_username?:string,queued_by_CRM?:boolean,queued_by_RE?:boolean,queued_by_Sugar?:boolean,queued_by_REGIS?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    email;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    queued_by_username;
    /** @type {boolean} */
    queued_by_CRM;
    /** @type {boolean} */
    queued_by_RE;
    /** @type {boolean} */
    queued_by_Sugar;
    /** @type {boolean} */
    queued_by_REGIS;
}

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

{
	regent_id: 0,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	email: String,
	phone_home: String,
	phone_bus: String,
	phone_cell: String,
	queued_by_username: String,
	queued_by_CRM: False,
	queued_by_RE: False,
	queued_by_Sugar: False,
	queued_by_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
		}
	},
	successfull: False
}