regis

<back to all web services

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
    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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}