regis

AppSettingsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/AppSettings

"use strict";
export class EmailAddresses {
    /** @param {{helpdesk?:string,registration?:string,developer?:string,developerAlt?:string,financialAid?:string,noReply?:string,carbonCopy?:string,distanceEducation?:string,studentServices?:string,admissions?:string,admissionsSE?:string,academicAdvising?:string,summerProgram?:string,libraryHold?:string,noEmail?:string,academicAdministrator?:string,accountant?:string,deanOfStudents?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    helpdesk;
    /** @type {string} */
    registration;
    /** @type {string} */
    developer;
    /** @type {string} */
    developerAlt;
    /** @type {string} */
    financialAid;
    /** @type {string} */
    noReply;
    /** @type {string} */
    carbonCopy;
    /** @type {string} */
    distanceEducation;
    /** @type {string} */
    studentServices;
    /** @type {string} */
    admissions;
    /** @type {string} */
    admissionsSE;
    /** @type {string} */
    academicAdvising;
    /** @type {string} */
    summerProgram;
    /** @type {string} */
    libraryHold;
    /** @type {string} */
    noEmail;
    /** @type {string} */
    academicAdministrator;
    /** @type {string} */
    accountant;
    /** @type {string} */
    deanOfStudents;
}
export class AppSettingsResponse {
    /** @param {{responseStatus?:ResponseStatus,collegeName?:string,collegeID?:string,regisurl?:string,staffIPAddresses?:IList<string>,emailAddresses?:EmailAddresses,currentTerm?:string,previousTerm?:string,currentAcademicYear?:number,externalSSOURL?:string,externalSSOCookieName?:string,externalSSOCookieDomain?:string,ldapurl?:string,ldapSecondaryURL?:string,demoCredential?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    collegeName;
    /** @type {string} */
    collegeID;
    /** @type {string} */
    regisurl;
    /** @type {IList<string>} */
    staffIPAddresses;
    /** @type {EmailAddresses} */
    emailAddresses;
    /** @type {string} */
    currentTerm;
    /** @type {string} */
    previousTerm;
    /** @type {number} */
    currentAcademicYear;
    /** @type {string} */
    externalSSOURL;
    /** @type {string} */
    externalSSOCookieName;
    /** @type {string} */
    externalSSOCookieDomain;
    /** @type {string} */
    ldapurl;
    /** @type {string} */
    ldapSecondaryURL;
    /** @type {string} */
    demoCredential;
}
export class AppSettingsRequest {
    constructor(init) { Object.assign(this, init) }
}

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

{
	
}

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
		}
	},
	collegeName: String,
	collegeID: String,
	regisurl: String,
	emailAddresses: 
	{
		helpdesk: String,
		registration: String,
		developer: String,
		developerAlt: String,
		financialAid: String,
		noReply: String,
		carbonCopy: String,
		distanceEducation: String,
		studentServices: String,
		admissions: String,
		admissionsSE: String,
		academicAdvising: String,
		summerProgram: String,
		libraryHold: String,
		noEmail: String,
		academicAdministrator: String,
		accountant: String,
		deanOfStudents: String
	},
	currentTerm: String,
	previousTerm: String,
	currentAcademicYear: 0,
	externalSSOURL: String,
	externalSSOCookieName: String,
	externalSSOCookieDomain: String,
	ldapurl: String,
	ldapSecondaryURL: String,
	demoCredential: String
}