regis

<back to all web services

AppSettingsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/AppSettings
namespace regis.ClassLibrary.Settings

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type EmailAddresses() = 
        member val helpdesk:String = null with get,set
        member val registration:String = null with get,set
        member val developer:String = null with get,set
        member val financialAid:String = null with get,set
        member val noReply:String = null with get,set
        member val carbonCopy:String = null with get,set
        member val distanceEducation:String = null with get,set
        member val studentServices:String = null with get,set
        member val admissions:String = null with get,set
        member val admissionsSE:String = null with get,set
        member val academicAdvising:String = null with get,set
        member val summerProgram:String = null with get,set
        member val libraryHold:String = null with get,set
        member val noEmail:String = null with get,set
        member val academicAdministrator:String = null with get,set
        member val accountant:String = null with get,set
        member val deanOfStudents:String = null with get,set

    [<AllowNullLiteral>]
    type AppSettingsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val CollegeName:String = null with get,set
        member val CollegeID:String = null with get,set
        member val REGISURL:String = null with get,set
        member val StaffIPAddresses:IList<String> = null with get,set
        member val EmailAddresses:EmailAddresses = null with get,set
        member val CurrentTerm:String = null with get,set
        member val PreviousTerm:String = null with get,set
        member val CurrentAcademicYear:Int32 = new Int32() with get,set
        member val ExternalSSOURL:String = null with get,set
        member val ExternalSSOCookieName:String = null with get,set
        member val ExternalSSOCookieDomain:String = null with get,set
        member val LDAPURL:String = null with get,set
        member val LDAPSecondaryURL:String = null with get,set
        member val DemoCredential:String = null with get,set

    [<AllowNullLiteral>]
    type AppSettingsRequest() = 
        class end

F# 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
}