regis

<back to all web services

AppSettingsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/AppSettings
import java.math.*
import java.util.*
import net.servicestack.client.*


open class AppSettingsRequest
{
}

open class AppSettingsResponse
{
    var responseStatus:ResponseStatus? = null
    var collegeName:String? = null
    var collegeID:String? = null
    var regisurl:String? = null
    var staffIPAddresses:IList<String>? = null
    var emailAddresses:EmailAddresses? = null
    var currentTerm:String? = null
    var previousTerm:String? = null
    var currentAcademicYear:Int? = null
    var externalSSOURL:String? = null
    var externalSSOCookieName:String? = null
    var externalSSOCookieDomain:String? = null
    var ldapurl:String? = null
    var ldapSecondaryURL:String? = null
    var demoCredential:String? = null
}

open class EmailAddresses
{
    var helpdesk:String? = null
    var registration:String? = null
    var developer:String? = null
    var financialAid:String? = null
    var noReply:String? = null
    var carbonCopy:String? = null
    var distanceEducation:String? = null
    var studentServices:String? = null
    var admissions:String? = null
    var admissionsSE:String? = null
    var academicAdvising:String? = null
    var summerProgram:String? = null
    var libraryHold:String? = null
    var noEmail:String? = null
    var academicAdministrator:String? = null
    var accountant:String? = null
    var deanOfStudents:String? = null
}

Kotlin 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
}