regis

<back to all web services

AppSettingsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/AppSettings
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Settings;

namespace regis.ClassLibrary.Settings
{
    public partial class AppSettingsRequest
    {
    }

    public partial class AppSettingsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string CollegeName { get; set; }
        public virtual string CollegeID { get; set; }
        public virtual string REGISURL { get; set; }
        public virtual IList<string> StaffIPAddresses { get; set; }
        public virtual EmailAddresses EmailAddresses { get; set; }
        public virtual string CurrentTerm { get; set; }
        public virtual string PreviousTerm { get; set; }
        public virtual int CurrentAcademicYear { get; set; }
        public virtual string ExternalSSOURL { get; set; }
        public virtual string ExternalSSOCookieName { get; set; }
        public virtual string ExternalSSOCookieDomain { get; set; }
        public virtual string LDAPURL { get; set; }
        public virtual string LDAPSecondaryURL { get; set; }
        public virtual string DemoCredential { get; set; }
    }

    public partial class EmailAddresses
    {
        public virtual string helpdesk { get; set; }
        public virtual string registration { get; set; }
        public virtual string developer { get; set; }
        public virtual string financialAid { get; set; }
        public virtual string noReply { get; set; }
        public virtual string carbonCopy { get; set; }
        public virtual string distanceEducation { get; set; }
        public virtual string studentServices { get; set; }
        public virtual string admissions { get; set; }
        public virtual string admissionsSE { get; set; }
        public virtual string academicAdvising { get; set; }
        public virtual string summerProgram { get; set; }
        public virtual string libraryHold { get; set; }
        public virtual string noEmail { get; set; }
        public virtual string academicAdministrator { get; set; }
        public virtual string accountant { get; set; }
        public virtual string deanOfStudents { get; set; }
    }

}

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