regis

AppSettingsRequest

**Requires Authentication**
Required role:	REGISUserRole

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

"use strict";
export class EmailAddresses {
    /** @param {{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}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    helpdesk;
    /** @type {string} */
    registration;
    /** @type {string} */
    developer;
    /** @type {string} */
    financialAid;
    /** @type {string} */
    noReply;
    /** @type {string} */
    carbonCopy;
    /** @type {string} */
    distanceEducation;
    /** @type {string} */
    studentServices;
    /** @type {string} */
    admissions;
    /** @type {string} */
    admissionsSE;
    /** @type {string} */
    academicAdvising;
    /** @type {string} */
    summerProgram;
    /** @type {string} */
    libraryHold;
    /** @type {string} */
    noEmail;
    /** @type {string} */
    academicAdministrator;
    /** @type {string} */
    accountant;
    /** @type {string} */
    deanOfStudents;
}
export class AppSettingsResponse {
    /** @param {{responseStatus?:ResponseStatus,collegeName?:string,collegeID?:string,regisurl?:string,staffIPAddresses?:IList<string>,emailAddresses?:EmailAddresses,currentTerm?:string,previousTerm?:string,currentAcademicYear?:number,externalSSOURL?:string,externalSSOCookieName?:string,externalSSOCookieDomain?:string,ldapurl?:string,ldapSecondaryURL?:string,demoCredential?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    collegeName;
    /** @type {string} */
    collegeID;
    /** @type {string} */
    regisurl;
    /** @type {IList<string>} */
    staffIPAddresses;
    /** @type {EmailAddresses} */
    emailAddresses;
    /** @type {string} */
    currentTerm;
    /** @type {string} */
    previousTerm;
    /** @type {number} */
    currentAcademicYear;
    /** @type {string} */
    externalSSOURL;
    /** @type {string} */
    externalSSOCookieName;
    /** @type {string} */
    externalSSOCookieDomain;
    /** @type {string} */
    ldapurl;
    /** @type {string} */
    ldapSecondaryURL;
    /** @type {string} */
    demoCredential;
}
export class AppSettingsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript AppSettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AppSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Settings" />

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AppSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Settings">
  <CollegeID>String</CollegeID>
  <CollegeName>String</CollegeName>
  <CurrentAcademicYear>0</CurrentAcademicYear>
  <CurrentTerm>String</CurrentTerm>
  <DemoCredential>String</DemoCredential>
  <EmailAddresses>
    <academicAdministrator>String</academicAdministrator>
    <academicAdvising>String</academicAdvising>
    <accountant>String</accountant>
    <admissions>String</admissions>
    <admissionsSE>String</admissionsSE>
    <carbonCopy>String</carbonCopy>
    <deanOfStudents>String</deanOfStudents>
    <developer>String</developer>
    <distanceEducation>String</distanceEducation>
    <financialAid>String</financialAid>
    <helpdesk>String</helpdesk>
    <libraryHold>String</libraryHold>
    <noEmail>String</noEmail>
    <noReply>String</noReply>
    <registration>String</registration>
    <studentServices>String</studentServices>
    <summerProgram>String</summerProgram>
  </EmailAddresses>
  <ExternalSSOCookieDomain>String</ExternalSSOCookieDomain>
  <ExternalSSOCookieName>String</ExternalSSOCookieName>
  <ExternalSSOURL>String</ExternalSSOURL>
  <LDAPSecondaryURL>String</LDAPSecondaryURL>
  <LDAPURL>String</LDAPURL>
  <PreviousTerm>String</PreviousTerm>
  <REGISURL>String</REGISURL>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StaffIPAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</AppSettingsResponse>