regis

AppSettingsRequest

**Requires Authentication**
Required role:	REGISUserRole

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Settings

Namespace Global

    Namespace regis.ClassLibrary.Settings

        Public Partial Class AppSettingsRequest
        End Class

        Public Partial Class AppSettingsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property CollegeName As String
            Public Overridable Property CollegeID As String
            Public Overridable Property REGISURL As String
            Public Overridable Property StaffIPAddresses As IList(Of String)
            Public Overridable Property EmailAddresses As EmailAddresses
            Public Overridable Property CurrentTerm As String
            Public Overridable Property PreviousTerm As String
            Public Overridable Property CurrentAcademicYear As Integer
            Public Overridable Property ExternalSSOURL As String
            Public Overridable Property ExternalSSOCookieName As String
            Public Overridable Property ExternalSSOCookieDomain As String
            Public Overridable Property LDAPURL As String
            Public Overridable Property LDAPSecondaryURL As String
            Public Overridable Property DemoCredential As String
        End Class

        Public Partial Class EmailAddresses
            Public Overridable Property helpdesk As String
            Public Overridable Property registration As String
            Public Overridable Property developer As String
            Public Overridable Property financialAid As String
            Public Overridable Property noReply As String
            Public Overridable Property carbonCopy As String
            Public Overridable Property distanceEducation As String
            Public Overridable Property studentServices As String
            Public Overridable Property admissions As String
            Public Overridable Property admissionsSE As String
            Public Overridable Property academicAdvising As String
            Public Overridable Property summerProgram As String
            Public Overridable Property libraryHold As String
            Public Overridable Property noEmail As String
            Public Overridable Property academicAdministrator As String
            Public Overridable Property accountant As String
            Public Overridable Property deanOfStudents As String
        End Class
    End Namespace
End Namespace

VB.NET 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
}