Modern Campus CMS API Documentation
This page documents all the available CMS APIs for your use. Some API paths begin with /rs/
, indicating that those follow REST standards, while the others do not adhere to REST. Please note that REST APIs will be inaccessible when the CMS is not available.
API ChangesLink to this section
Review the API changes in Modern Campus CMS 2024.2.
To use any of the APIs via a script, you will need to login first, that will return back a gadget_token
, and it will need to appended as a custom header of X-Auth-Token
to all the following calls. Here is the Example JavaScript Code demonstrating this logic.
If you are using an Authentication method to login into the CMS, you will need to enable the WebDAV setting on the user that you wish to use with the API, which will require the user to have a password local to the CMS. WebDAV is only available for level 9 and 10 users. You will then be able to use the standard login method with username and password.
Example JavaScript CodeLink to this section
(async () => {
const connect = async () => {
const body = new URLSearchParams();
body.append('skin', '[SKINNAME]');
body.append('account', '[ACCOUNT]');
body.append('username', '[USERNAME]');
body.append('password', '[PASSWORD]');
const response = await fetch('https://a.cms.omniupdate.com/authentication/login', {
method: 'POST',
body,
});
return response.json()
};
const data = await connect();
const token = data.gadget_token;
console.log(`#######\n Got Token: ${token} \n#######`);
const groupList = await fetch('https://a.cms.omniupdate.com/users/groups?user=[username]', {
headers: {
'X-Auth-Token': token
}
});
const groupData = await groupList.json();
console.log(groupData);
})();