Required role: | REGISUserRole |
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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>