regis

<back to all web services

AppSettingsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/AppSettings

export class EmailAddresses
{
    public helpdesk: string;
    public registration: string;
    public developer: string;
    public financialAid: string;
    public noReply: string;
    public carbonCopy: string;
    public distanceEducation: string;
    public studentServices: string;
    public admissions: string;
    public admissionsSE: string;
    public academicAdvising: string;
    public summerProgram: string;
    public libraryHold: string;
    public noEmail: string;
    public academicAdministrator: string;
    public accountant: string;
    public deanOfStudents: string;

    public constructor(init?: Partial<EmailAddresses>) { (Object as any).assign(this, init); }
}

export class AppSettingsResponse
{
    public responseStatus: ResponseStatus;
    public collegeName: string;
    public collegeID: string;
    public regisurl: string;
    public staffIPAddresses: IList<string>;
    public emailAddresses: EmailAddresses;
    public currentTerm: string;
    public previousTerm: string;
    public currentAcademicYear: number;
    public externalSSOURL: string;
    public externalSSOCookieName: string;
    public externalSSOCookieDomain: string;
    public ldapurl: string;
    public ldapSecondaryURL: string;
    public demoCredential: string;

    public constructor(init?: Partial<AppSettingsResponse>) { (Object as any).assign(this, init); }
}

export class AppSettingsRequest
{

    public constructor(init?: Partial<AppSettingsRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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,
		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
}