regis

<back to all web services

AppSettingsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/AppSettings
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class EmailAddresses implements IConvertible
{
    String? 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;

    EmailAddresses({this.helpdesk,this.registration,this.developer,this.financialAid,this.noReply,this.carbonCopy,this.distanceEducation,this.studentServices,this.admissions,this.admissionsSE,this.academicAdvising,this.summerProgram,this.libraryHold,this.noEmail,this.academicAdministrator,this.accountant,this.deanOfStudents});
    EmailAddresses.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        helpdesk = json['helpdesk'];
        registration = json['registration'];
        developer = json['developer'];
        financialAid = json['financialAid'];
        noReply = json['noReply'];
        carbonCopy = json['carbonCopy'];
        distanceEducation = json['distanceEducation'];
        studentServices = json['studentServices'];
        admissions = json['admissions'];
        admissionsSE = json['admissionsSE'];
        academicAdvising = json['academicAdvising'];
        summerProgram = json['summerProgram'];
        libraryHold = json['libraryHold'];
        noEmail = json['noEmail'];
        academicAdministrator = json['academicAdministrator'];
        accountant = json['accountant'];
        deanOfStudents = json['deanOfStudents'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'helpdesk': helpdesk,
        'registration': registration,
        'developer': developer,
        'financialAid': financialAid,
        'noReply': noReply,
        'carbonCopy': carbonCopy,
        'distanceEducation': distanceEducation,
        'studentServices': studentServices,
        'admissions': admissions,
        'admissionsSE': admissionsSE,
        'academicAdvising': academicAdvising,
        'summerProgram': summerProgram,
        'libraryHold': libraryHold,
        'noEmail': noEmail,
        'academicAdministrator': academicAdministrator,
        'accountant': accountant,
        'deanOfStudents': deanOfStudents
    };

    getTypeName() => "EmailAddresses";
    TypeContext? context = _ctx;
}

class AppSettingsResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? collegeName;
    String? collegeID;
    String? regisurl;
    List<String>? staffIPAddresses;
    EmailAddresses? emailAddresses;
    String? currentTerm;
    String? previousTerm;
    int? currentAcademicYear;
    String? externalSSOURL;
    String? externalSSOCookieName;
    String? externalSSOCookieDomain;
    String? ldapurl;
    String? ldapSecondaryURL;
    String? demoCredential;

    AppSettingsResponse({this.responseStatus,this.collegeName,this.collegeID,this.regisurl,this.staffIPAddresses,this.emailAddresses,this.currentTerm,this.previousTerm,this.currentAcademicYear,this.externalSSOURL,this.externalSSOCookieName,this.externalSSOCookieDomain,this.ldapurl,this.ldapSecondaryURL,this.demoCredential});
    AppSettingsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        collegeName = json['collegeName'];
        collegeID = json['collegeID'];
        regisurl = json['regisurl'];
        staffIPAddresses = JsonConverters.fromJson(json['staffIPAddresses'],'List<String>',context!);
        emailAddresses = JsonConverters.fromJson(json['emailAddresses'],'EmailAddresses',context!);
        currentTerm = json['currentTerm'];
        previousTerm = json['previousTerm'];
        currentAcademicYear = json['currentAcademicYear'];
        externalSSOURL = json['externalSSOURL'];
        externalSSOCookieName = json['externalSSOCookieName'];
        externalSSOCookieDomain = json['externalSSOCookieDomain'];
        ldapurl = json['ldapurl'];
        ldapSecondaryURL = json['ldapSecondaryURL'];
        demoCredential = json['demoCredential'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'collegeName': collegeName,
        'collegeID': collegeID,
        'regisurl': regisurl,
        'staffIPAddresses': JsonConverters.toJson(staffIPAddresses,'List<String>',context!),
        'emailAddresses': JsonConverters.toJson(emailAddresses,'EmailAddresses',context!),
        'currentTerm': currentTerm,
        'previousTerm': previousTerm,
        'currentAcademicYear': currentAcademicYear,
        'externalSSOURL': externalSSOURL,
        'externalSSOCookieName': externalSSOCookieName,
        'externalSSOCookieDomain': externalSSOCookieDomain,
        'ldapurl': ldapurl,
        'ldapSecondaryURL': ldapSecondaryURL,
        'demoCredential': demoCredential
    };

    getTypeName() => "AppSettingsResponse";
    TypeContext? context = _ctx;
}

class AppSettingsRequest implements IConvertible
{
    AppSettingsRequest();
    AppSettingsRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "AppSettingsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'EmailAddresses': TypeInfo(TypeOf.Class, create:() => EmailAddresses()),
    'AppSettingsResponse': TypeInfo(TypeOf.Class, create:() => AppSettingsResponse()),
    'AppSettingsRequest': TypeInfo(TypeOf.Class, create:() => AppSettingsRequest()),
});

Dart 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>