What is Residence?

Residence is the tool that enables your institution’s Housing office to process and track items related to student housing applications, room and meal assignments, billing process, room condition processes, and much more.

What is the Residence API?

The Residence REST API is a way in which you can obtain or input information to a Residence system without using the interface, usually using code. It allows for easy automation of tasks.

What kind of data can I get through the API?

Student, Room Assignment, Meal Assignment, and Application.

How do I get an API key?

The main administrator on your campus for Residence will be able to configure an API key for you. Please ask the main administrator to contact refer to the documentation in the Symplicity Help Center for further information.

What do I do if my API key is not working?

The main administrator for the Residence system on your campus will be able to assist in troubleshooting or may contact Symplicity support to report an issue.

What do I do if my API key has expired?

The main administrator for the Residence system on your campus will be able to assist or may contact Symplicity support to report an issue.

How does Authentication & Authorization work?

All routes require authentication with an encrypted token. You must add a token authentication header to your requests. Here is the format:



Basic [123xyz your token here]

Make sure you put the word “Basic” with a space before your actual token! Also, please note that the key-value pair should be sent in the headers and not in the username and password field required for Basic Authentication.

Are there limitations on the number of requests?

100 calls with a leak rate of 10 calls per second. If your app averages up to 10 calls per second it will never receive a “429 Rate Limit Exceeded Error”.

10,000 calls for a period of 24 hours, which will reset at midnight.

See the API documentation for further information.

Can I request a higher rate limit?

Not at this time.

What happens if I hit the rate limit?

You will be unable to read/write data until you are back under the limit. You will see an Error: “Rate Limit Exceeded Error”

What’s JSON?

JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, Python, and many others. These properties make JSON an ideal data-interchange language and a natural choice as a response for our REST APIs.

How are the POST, PUT, and GET calls different?

On a basic level, POST calls create records in the Residence system, GET calls get information out of the system, and PUT calls update current records in the system. For GET calls on the Residence API, you need to put the parameters in the URL, as well as have the authorization token in the header. For POST and PUT calls on the Residence API, you need the URL, the authorization token in the header, an added header (Content-Type:application/json;charset=UTF-8), and a body with the data that you want to input or update.

Does Symplicity have any code libraries or SDKs?

Not at this time.

Where can I find an example of code interacting with the API?

In our documentation, you can see example calls.

How can I test my API calls?

For institutions eligible for the Radius Program, Symplicity provides a test site, or sandbox. Please speak with the main administrator for the Residence system to have them submit a support request to have the testing environment configured.

How do I get support?

At this time, the main administrator for the Residence system will need to submit a support request for any issues you are having with the API.

Can I use the API commercially?

No, Symplicity does not allow for commercial use of the APIs other than with our partner program. If you would like to exchange data between another software system and Symplicity, please click on the link to see how we can connect.

How stable is the API? Does the API ever change? How can I learn about new features?

As far as API stability goes, the Residence API is backward compatible. Right now, the Residence API is version one, but we’ll move to version two if there are any backward-incompatible changes that need to be made. We will announce any new versions or new features as they are released.

Where can I find the Documentation?

The Residence Documentation can be found here.