regis

<back to all web services

AppSettingsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/AppSettings
AppSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CollegeNameformstringNo
CollegeIDformstringNo
REGISURLformstringNo
StaffIPAddressesformIList<string>No
EmailAddressesformEmailAddressesNo
CurrentTermformstringNo
PreviousTermformstringNo
CurrentAcademicYearformintNo
ExternalSSOURLformstringNo
ExternalSSOCookieNameformstringNo
ExternalSSOCookieDomainformstringNo
LDAPURLformstringNo
LDAPSecondaryURLformstringNo
DemoCredentialformstringNo
EmailAddresses Parameters:
NameParameterData TypeRequiredDescription
helpdeskformstringNo
registrationformstringNo
developerformstringNo
financialAidformstringNo
noReplyformstringNo
carbonCopyformstringNo
distanceEducationformstringNo
studentServicesformstringNo
admissionsformstringNo
admissionsSEformstringNo
academicAdvisingformstringNo
summerProgramformstringNo
libraryHoldformstringNo
noEmailformstringNo
academicAdministratorformstringNo
accountantformstringNo
deanOfStudentsformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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