regis

<back to all web services

AppSettingsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/AppSettings
import Foundation
import ServiceStack

public class AppSettingsRequest : Codable
{
    required public init(){}
}

public class AppSettingsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var collegeName:String
    public var collegeID:String
    public var regisurl:String
    public var staffIPAddresses:IList<String>
    public var emailAddresses:EmailAddresses
    public var currentTerm:String
    public var previousTerm:String
    public var currentAcademicYear:Int
    public var externalSSOURL:String
    public var externalSSOCookieName:String
    public var externalSSOCookieDomain:String
    public var ldapurl:String
    public var ldapSecondaryURL:String
    public var demoCredential:String

    required public init(){}
}

public class EmailAddresses : Codable
{
    public var helpdesk:String
    public var registration:String
    public var developer:String
    public var financialAid:String
    public var noReply:String
    public var carbonCopy:String
    public var distanceEducation:String
    public var studentServices:String
    public var admissions:String
    public var admissionsSE:String
    public var academicAdvising:String
    public var summerProgram:String
    public var libraryHold:String
    public var noEmail:String
    public var academicAdministrator:String
    public var accountant:String
    public var deanOfStudents:String

    required public init(){}
}


Swift 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"}