regis

AppSettingsRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EmailAddresses:
    helpdesk: Optional[str] = None
    registration: Optional[str] = None
    developer: Optional[str] = None
    developer_alt: Optional[str] = None
    financial_aid: Optional[str] = None
    no_reply: Optional[str] = None
    carbon_copy: Optional[str] = None
    distance_education: Optional[str] = None
    student_services: Optional[str] = None
    admissions: Optional[str] = None
    admissions_s_e: Optional[str] = None
    academic_advising: Optional[str] = None
    summer_program: Optional[str] = None
    library_hold: Optional[str] = None
    no_email: Optional[str] = None
    academic_administrator: Optional[str] = None
    accountant: Optional[str] = None
    dean_of_students: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppSettingsResponse:
    response_status: Optional[ResponseStatus] = None
    college_name: Optional[str] = None
    college_i_d: Optional[str] = None
    regisurl: Optional[str] = None
    staff_i_p_addresses: Optional[IList[str]] = None
    email_addresses: Optional[EmailAddresses] = None
    current_term: Optional[str] = None
    previous_term: Optional[str] = None
    current_academic_year: int = 0
    external_s_s_o_u_r_l: Optional[str] = None
    external_s_s_o_cookie_name: Optional[str] = None
    external_s_s_o_cookie_domain: Optional[str] = None
    ldapurl: Optional[str] = None
    ldap_secondary_u_r_l: Optional[str] = None
    demo_credential: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppSettingsRequest:
    pass

Python 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>
    <developerAlt>String</developerAlt>
    <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>