Required role: | REGISUserRole |
POST | /AppSettings |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
CollegeName | form | string | No | |
CollegeID | form | string | No | |
REGISURL | form | string | No | |
StaffIPAddresses | form | IList<string> | No | |
EmailAddresses | form | EmailAddresses | No | |
CurrentTerm | form | string | No | |
PreviousTerm | form | string | No | |
CurrentAcademicYear | form | int | No | |
ExternalSSOURL | form | string | No | |
ExternalSSOCookieName | form | string | No | |
ExternalSSOCookieDomain | form | string | No | |
LDAPURL | form | string | No | |
LDAPSecondaryURL | form | string | No | |
DemoCredential | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
helpdesk | form | string | No | |
registration | form | string | No | |
developer | form | string | No | |
financialAid | form | string | No | |
noReply | form | string | No | |
carbonCopy | form | string | No | |
distanceEducation | form | string | No | |
studentServices | form | string | No | |
admissions | form | string | No | |
admissionsSE | form | string | No | |
academicAdvising | form | string | No | |
summerProgram | form | string | No | |
libraryHold | form | string | No | |
noEmail | form | string | No | |
academicAdministrator | form | string | No | |
accountant | form | string | No | |
deanOfStudents | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK Content-Type: text/jsv 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 }